🚀 gRPC-server

gRPC-server is a powerful and flexible gRPC server designed to seamlessly interact with the Service Proto. This project provides a robust interface for communication between clients and the Service Proto, enabling efficient and streamlined data exchange.

🛠️ Installation

📦 Requirements

• 🐳 Docker
• ❄️ Nix (optional)

🔑 Set Up Environment Variables

Create a .env file in the project root with these variables:

# Server Configuration
ENVIRONMENT="local" # Current environment (Use in Jaeger, to dif`ferentiate between environments)
HTTP_PORT=3080 # HTTP port (Redirects to HTTPS)
HTTPS_PORT=3000 # HTTPS port
FRONT_URL="http://localhost:5173" # Your front-end URL
JAEGER_AGENT_HOST="http://localhost:4317" # Jaeger agent host

# AWS S3
AWS_S3_BUCKET_NAME="your-bucket" # Your S3 bucket name
AWS_REGION="eu-west-3" # Your AWS region

# Mailer
SMTP_HOST="smtp.service.com" # Your SMTP host
SMTP_USER="[email protected]" # Your SMTP user
SMTP_PASS="your_smtp_password" # Your SMTP password

# SurrealDB
SURREAL_LOG_LEVEL=info # [possible values: none,full, error, warn, info, debug, trace]
SURREAL_ADDRESS=172.17.0.1 # Docker host IP
SURREAL_PORT=8000 # Docker host port
SURREAL_DB_HOST="ws://${SURREAL_ADDRESS}:${SURREAL_PORT}" # SurrealDB host
SURREAL_USER=root # SurrealDB user
SURREAL_PASS=Ap@ssw0rdStr0ng3rTh@nTh3D3v1l # SurrealDB password, needs to be strong
SURREAL_NAMESPACE=kiro # SurrealDB namespace
SURREAL_DATABASE=client # SurrealDB database

🚀 Getting Started

🛠️ Using the Makefile

Useful commands:

# Windows (PowerShell)
.\make.ps1                  # Run the server
.\make.ps1 dev              # Start dev environment
.\make.ps1 version x.x.x    # Update version
.\make.ps1 docker-dev       # Start Docker development environment
.\make.ps1 test             # Run tests
.\make.ps1 test-all         # Run all tests including integration
.\make.ps1 help             # Show available commands
.\make.ps1 config           # Configure the server

# macOS and Linux
make                        # Run the server
make dev                    # Start dev environment
make version x.x.x          # Update version
make docker-dev             # Start Docker development environment
make test                   # Run tests
make test-all               # Run all tests including integration
make help                   # Show available commands
make config                 # Configure the server

🐳 Docker Setup

docker compose up -d

Build Docker image:

docker compose build

🖥️ Manual Setup

Run the server:

# Windows (PowerShell)
.\make.ps1

# macOS and Linux
make

📊 Run OpenTelemetry

docker compose up -d jaeger

Access Jaeger UI

🛠️ Nix Setup

If you have Nix installed, you can use it to set up the development environment:

# Windows (PowerShell)
.\make.ps1 dev

# macOS and Linux
make dev

To use the specific Nixpkgs version (nixos-24.05), you can run:

nix-shell -I nixpkgs=https://github.com/NixOS/nixpkgs/archive/nixos-24.05.tar.gz

🧹 Nix Maintenance

To clean the Nix store:

nix-store --gc

To add user permissions to the Nix folder:

# Windows (PowerShell)
icacls C:\nix /grant "$env:USERNAME:(OI)(CI)F" /T

# macOS and Linux
sudo chown --recursive "$USER" /nix

👥 Nix Multi-User Setup

To set up Nix with multi-user support:

1. Install Nix in multi-user mode:

   # Windows (PowerShell)
   iex ((New-Object System.Net.WebClient).DownloadString('https://nixos.org/nix/install')) -daemon
   
   # macOS and Linux
   sh <(curl -L https://nixos.org/nix/install) --daemon

2. Create and start the nix-daemon service:

   # Windows (PowerShell)
   # Not applicable, Windows uses a different service management system
   
   # macOS and Linux
   sudo mkdir -p /etc/systemd/system
   sudo curl -o /etc/systemd/system/nix-daemon.service https://raw.githubusercontent.com/NixOS/nix/master/etc/systemd/nix-daemon.service
   sudo systemctl enable nix-daemon
   sudo systemctl start nix-daemon

3. Add Nix bin to PATH:

   # Windows (PowerShell)
   [Environment]::SetEnvironmentVariable("Path", $env:Path + ";C:\nix\usr\bin", [EnvironmentVariableTarget]::Machine)
   
   # macOS and Linux
   echo 'export PATH=$PATH:/nix/var/nix/profiles/default/bin' | sudo tee -a /etc/profile

4. Create nixbld group and add users:

   # Windows (PowerShell)
   # Not applicable, Windows uses a different user/group management system
   
   # macOS
   sudo dscl . -create /Groups/nixbld
   sudo dscl . -create /Groups/nixbld PrimaryGroupID 301
   sudo dscl . -create /Users/nixbld1 UniqueID 301
   sudo dscl . -create /Users/nixbld1 PrimaryGroupID 301
   sudo dscl . -append /Groups/nixbld GroupMembership nixbld1
   sudo dscl . -append /Groups/nixbld GroupMembership yourusername
   
   # Linux
   sudo groupadd nixbld
   sudo usermod -a -G nixbld yourusername

5. Set up Nix configuration:

   # Windows (PowerShell)
   New-Item -ItemType Directory -Force -Path "$env:APPDATA\nix"
   Add-Content "$env:APPDATA\nix\nix.conf" "build-users-group = nixbld"
   
   # macOS and Linux
   sudo mkdir -p /etc/nix
   echo "build-users-group = nixbld" | sudo tee -a /etc/nix/nix.conf

6. Restart your shell or log out and back in.

For MacOS users, some commands might differ. Always refer to the official Nix documentation for the most up-to-date instructions.

Happy coding! 🎈🎊