Merge pull request #98 from metakgp/backend-rs

[HOLY WAR] Rustified Backend

Author: harshkhandeparkar

README.md

@@ -60,7 +60,7 @@ IQPS was originally created by [Shubham Mishra](https://github.com/grapheo12) in
     - Make the env file by copying the template: `cp .env.template .env`
     - Fill the env variable and set `DB_HOST=localhost` for running locally for development
     - Start the DB by running `docker compose -f docker-compose.dev.yaml up -d`
-    - Start the Go backend by running `go run .`
+    - Start the Rust backend by running `cargo run .`
 3. Set up the frontend by running `pnpm install` and then `pnpm start` in the `frontend/` directory.
 4. Profit.
 
@@ -77,20 +77,38 @@ IQPS was originally created by [Shubham Mishra](https://github.com/grapheo12) in
 5. Optionally set up a Systemd service to start the wiki on startup or use this [deployment github workflow](./.github/workflows/deploy.yaml).
 
 ### Environment Variables
-Environment variables can be set using a `.env` file. Use the `.env.template` files for reference.
+Environment variables can be set using a `.env` file. Use the `.env.template` files for reference. See `backend/src/env.rs` for more documentation and types.
 
 #### Backend
-- `DB_PATH`: Path to the database file to use.
-- `STATIC_FILES_URL`: The base URL for the static files (PDFs).
-- `QPS_PATH`: The local path on the server to store question paper PDFs.
-- `DB_NAME`: The name for your database.
-- `DB_HOST`: `localhost` if using local postgres server or set your **own** database host address.
-- `DB_PORT`: `5432` if using local postgres server, or set to your **own** database port.
-- `DB_USER`: The access username for database.
-- `DB_PASSWORD`: The access password corressponding to the user.
+##### Database (Postgres)
+- `DB_NAME`: Database name
+- `DB_HOST`: Database hostname (eg: `localhost`)
+- `DB_PORT`: Database port
+- `DB_USER`: Database username
+- `DB_PASSWORD`: Database password
+
+##### Authentication
+- `GH_CLIENT_ID`: Client ID of the Github OAuth app.
+- `GH_CLIENT_SECRET`: Client secret of the Github OAuth app.
+- `GH_ORG_NAME`: The name of the Github organization of the admins.
+- `GH_ORG_TEAM_SLUG`: The URL slug of the Github org team of the admins.
+- `JWT_SECRET`: A secret key/password for JWT signing. It should be a long, random, unguessable string.
+
+##### Configuration
+- `MAX_UPLOAD_LIMIT`: Maximum number of files that can be uploaded at once.
+- `LOG_LOCATION`: The path to a local logfile.
+- `STATIC_FILES_URL`: The URL of the static files server. (eg: `https://static.metakgp.org`)
+- `STATIC_FILE_STORAGE_LOCATION`: The path to the local directory from which the static files are served.
+- `UPLOADED_QPS_PATH`: A path relative to `STATIC_FILE_STORAGE_LOCATION` where the uploaded question papers will be stored. (eg: `iqps/uploaded`)
+- `LIBRARY_QPS_PATH`: A path relative to `STATIC_FILE_STORAGE_LOCATION` where the library question papers are scraped and stored. (eg: `peqp/qp`)
+- `SERVER_PORT`: The port on which the server listens.
+- `CORS_ALLOWED_ORIGINS`: A comma (,) separated list of origins to be allowed in CORS.
 
 #### Frontend
-- `VITE_BACKEND_URL`: The IQPS backend URL. Use `http://localhost:5000` in development.
+- `VITE_BACKEND_URL`: The IQPS backend URL. Use `http://localhost:8080` in development.
+- `VITE_MAX_UPLOAD_LIMIT` The maximum number of files that can be uploaded at once. (Note: This is only a client-side limit)
+- `VITE_GH_OAUTH_CLIENT_ID` The Client ID of the Github OAuth app.
+
 
 ## Contact
 

backend-go-old/.env.template

@@ -0,0 +1,16 @@
+STATIC_FILES_URL=https://static.metakgp.org
+DB_NAME=
+DB_HOST=
+DB_PORT=
+DB_USER=
+DB_PASSWORD=
+STATIC_FILES_STORAGE_LOCATION=/srv/static
+UPLOADED_QPS_PATH=iqps/uploaded # Relative to `STATIC_FILES_STORAGE_LOCATION`. Final upload location will be /srv/static/iqps/uploaded
+MAX_UPLOAD_LIMIT=10
+GH_CLIENT_ID= # public token of the oauth app
+GH_PRIVATE_ID= # Private token of the oauth app
+JWT_SECRET= # JWT encryption secret
+GH_ORG_NAME= # name of the org
+GH_ORG_TEAM_SLUG= #URL friendly team Name
+GH_ORG_ADMIN_TOKEN= #GH TOKEN OF AN ORG ADMIN
+IQPS_LOG_LOCATION=./log/application.log

backend-go-old/Dockerfile

@@ -0,0 +1,27 @@
+FROM golang:1.22.4 AS builder
+
+WORKDIR /src
+
+COPY go.mod go.sum ./
+
+RUN go mod download
+
+COPY . .
+
+RUN CGO_ENABLED=1 GOOS=linux go build -o ./build --tags "fts5" -a -ldflags '-linkmode external -extldflags "-static"' .
+
+FROM alpine:latest AS app
+
+RUN apk --no-cache add tzdata ca-certificates bash
+
+ENV TZ="Asia/Kolkata"
+
+WORKDIR /app
+
+COPY metaploy/ ./
+
+RUN chmod +x ./postinstall.sh
+
+COPY --from=builder /src/build .
+
+CMD ["./postinstall.sh", "./build"]

backend/courses.csv renamed to backend-go-old/courses.csv

@@ -9,7 +9,7 @@ services:
       - PGPORT=${DB_PORT}
       - PGHOST=${DB_HOST}
     healthcheck:
-      test: ["CMD", "pg_isready", "-U", "${POSTGRES_USER}", "${POSTGRES_DB}"]
+      test: ["CMD", "pg_isready", "-U", "postgres"]
       interval: 5s
       timeout: 3s
       retries: 20

backend-rs/docker-compose.dev.yaml renamed to backend-go-old/docker-compose.dev.yaml

@@ -0,0 +1,34 @@
+services:
+  iqps-backend:
+    image: metakgporg/iqps-backend
+    container_name: iqps-backend
+    build: .
+    restart: always
+    env_file:
+      - .env
+    networks:
+      metaploy-network:
+        aliases:
+          - iqps-backend
+      metaploy-private-network:
+    volumes:
+      - ./logs:/var/log/iqps/logs
+      - ./db:/db
+      - nginx-config-volume:/etc/nginx/sites-enabled
+      - odins-vault:/srv/static
+
+networks:
+  metaploy-network:
+    external: true
+    name: metaploy-network
+  metaploy-private-network:
+    external: true
+    name: metaploy-private-network
+
+volumes:
+  nginx-config-volume:
+    external: true
+    name: metaploy-nginx-config-volume
+  odins-vault:
+    external: true
+    name: odins-vault