fix: minor QoL improvements and updated documentation and compose files (#193)

* fix: minor QoL improvements and updated documentation and compose files

* chore: format

Author: AyushSehrawat

.env.example

@@ -20,8 +20,6 @@ COPY --from=frontend  /app/node_modules /riven/node_modules
 COPY --from=frontend  /app/package.json /riven/package.json
 COPY version.txt /riven/
 
-# ENTRYPOINT ["ORIGIN=$ORIGIN", "BACKEND_URL=$BACKEND_URL", "node", "/riven/build"]
-
 # Add the entrypoint script
 COPY docker-entrypoint.sh /usr/local/bin/
 RUN chmod +x /usr/local/bin/docker-entrypoint.sh

Dockerfile

@@ -34,25 +34,7 @@ To run the frontend, you need to have the backend running. You can find the back
 
 Make sure you have docker and docker-compose installed on your system.
 
-Edit the `docker-compose.yml` (make sure to replace the environment variables with your own) file to match your setup:
-
-> [!IMPORTANT]  
-> It is very important to set the `ORIGIN` and `BACKEND_URL` environment variables correctly to make the frontend work properly. Read more about them [here](#environment-variables).
-
-```yml
-services:
-  riven-frontend:
-    image: ghcr.io/rivenmedia/riven-frontend:latest
-    container_name: riven-frontend
-    restart: unless-stopped
-    tty: true
-    environment:
-      - ORIGIN=http://localhost:3000 # No trailing slash, read more below
-      - BACKEND_URL=http://127.0.0.1:8080 # No trailing slash, read more below
-      - TZ=America/New_York
-    ports:
-      - '3000:3000'
-```
+Edit the [`docker-compose.yml`](./docker-compose.yml) (make sure to replace the environment variables with your own) file to match your setup:
 
 Then run the following command:
 
@@ -83,16 +65,17 @@ It will build the frontend in the `build` directory.
 Then run the following command:
 
 ```bash
-ORIGIN=http://localhost:3000 BACKEND_URL=http://127.0.0.1:8080 node build
+ORIGIN=http://localhost:3000 node build
 ```
 
 It will start the frontend on port `3000`.
 
 ### Environment variables
 
-- `ORIGIN`: It's the URL you will use to access the frontend. If running behind a reverse proxy, you should set it to the URL of the reverse proxy, like `https://riven.example.com`. If running locally, you can let it be `http://localhost:3000` or you local server IP address like `http://192.168.1.45:3000`.
+> [!IMPORTANT]  
+> `ORIGIN` is optional and is not required if you are using reverse proxy, which usually forwards the `x-forwarded-proto` and `x-forwarded-host` headers. If you are running the frontend directly, you should set the `ORIGIN` environment variable to the URL you will use to access the frontend.
 
-- `BACKEND_URL`: The URL of the backend. Default should work in most cases. You can also replace it with container name of backend if you are using docker-compose.
+`ORIGIN`: It's the URL you will use to access the frontend. If running behind a reverse proxy, you should set it to the URL of the reverse proxy, like `https://riven.example.com`. If running locally, you can let it be `http://localhost:3000` or you local server IP address like `http://192.168.1.45:3000`.
 
 ---
 

README.md

@@ -1,12 +1,17 @@
 services:
   riven-frontend:
-    image: spoked/riven-frontend:latest
+    image: spoked/riven-frontend:latest # Tags: latest/dev/x.x.x
     container_name: riven-frontend
     restart: unless-stopped
     tty: true
     environment:
-      - ORIGIN=http://localhost:3000 # No trailing slash, read more below
-      - BACKEND_URL=http://127.0.0.1:8080 # No trailing slash, read more below
+      - ORIGIN=http://localhost:3000 # (Optional) No trailing slash, read more below
       - TZ=America/New_York
-    ports:
-      - '3000:3000'
+    expose:
+      - 3000
+
+    # (Optional) Uncomment the following lines to bind the port to the host machine
+    # ports:
+    #   - 3000:3000
+    volumes:
+      - ./config:/riven/config

docker-compose.yml

@@ -7,5 +7,4 @@ else
     export ORIGIN=${ORIGIN}
 fi
 
-export BACKEND_URL=${BACKEND_URL}
 exec "$@"

docker-entrypoint.sh

@@ -17,29 +17,30 @@
 	"devDependencies": {
 		"@hey-api/openapi-ts": "^0.53.12",
 		"@sveltejs/adapter-node": "^5.2.12",
-		"@sveltejs/kit": "^2.17.2",
+		"@sveltejs/kit": "^2.19.0",
 		"@sveltejs/vite-plugin-svelte": "^3.1.2",
+		"@tailwindcss/container-queries": "^0.1.1",
 		"@tailwindcss/typography": "^0.5.16",
 		"@types/eslint": "^8.56.12",
 		"@types/luxon": "^3.4.2",
 		"@types/nprogress": "^0.2.3",
 		"@types/uuid": "^9.0.8",
-		"@types/ws": "^8.5.14",
-		"autoprefixer": "^10.4.20",
-		"eslint": "^9.20.1",
+		"@types/ws": "^8.18.0",
+		"autoprefixer": "^10.4.21",
+		"eslint": "^9.22.0",
 		"eslint-config-prettier": "^9.1.0",
 		"eslint-plugin-svelte": "^2.46.1",
 		"globals": "^15.15.0",
 		"postcss": "^8.5.3",
-		"prettier": "^3.5.1",
+		"prettier": "^3.5.3",
 		"prettier-plugin-svelte": "^3.3.3",
 		"prettier-plugin-tailwindcss": "^0.5.14",
 		"svelte": "^4.2.19",
 		"svelte-check": "^3.8.6",
-		"sveltekit-sse": "^0.13.12",
+		"sveltekit-sse": "^0.13.14",
 		"tailwindcss": "^3.4.17",
 		"tslib": "^2.8.1",
-		"typescript": "^5.7.3",
+		"typescript": "^5.8.2",
 		"typescript-eslint": "8.0.0-alpha.28",
 		"vite": "^5.4.14",
 		"vitest": "^2.1.9"
@@ -59,12 +60,12 @@
 		"motion": "^10.18.0",
 		"nprogress": "^0.2.0",
 		"svelte-sonner": "^0.3.28",
-		"sveltekit-superforms": "^2.23.1",
+		"sveltekit-superforms": "^2.24.0",
 		"tailwind-merge": "^2.6.0",
 		"tailwind-variants": "^0.2.1",
 		"uuid": "^9.0.1",
 		"vaul-svelte": "^0.3.2",
-		"ws": "^8.18.0",
+		"ws": "^8.18.1",
 		"zod": "^3.24.2"
 	},
 	"packageManager": "pnpm@9.5.0",