vodorod/parcer
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Merge pull request #105 from getmaxun/develop

Browse Source 
docs: docker compose & backend env variables
This commit is contained in:
amhsirak
2024-11-03 04:15:35 +05:30
committed by GitHub
parent 876a2a124d 3bf284e2df
commit 77ef97909e
1 changed files with 3 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
README.md
View File

@@ -26,7 +26,7 @@ Maxun lets you train a robot in 2 minutes and scrape the web on auto-pilot. Web
<img src="https://static.scarf.sh/a.png?x-pxid=c12a77cc-855e-4602-8a0f-614b2d0da56a" /> <img src="https://static.scarf.sh/a.png?x-pxid=c12a77cc-855e-4602-8a0f-614b2d0da56a" />
# Local Setup # Local Setup
### Docker ### Docker Compose
``` ```
docker-compose up -d --build docker-compose up -d --build
``` ```
@@ -56,7 +56,8 @@ You can access the frontend at http://localhost:5173/ and backend at http://loca
# Envirnoment Variables # Envirnoment Variables
| Variable | Mandatory | Description | If Not Set | | Variable | Mandatory | Description | If Not Set |
|-----------------------|-----------|----------------------------------------------------------------------------------------------|--------------------------------------------------------------| |-----------------------|-----------|----------------------------------------------------------------------------------------------|--------------------------------------------------------------|
| `NODE_ENV` | Yes | Defines the app environment (`development`, `production`). | Defaults to `development`. | | `BACKEND_URL` | Yes | URL to run backend on. | Backend won't start. If not sure, set to http://localhost:8080/ |
| `VITE_BACKEND_URL` | Yes | URL to run backend on. | Backend won't start. If not sure, set to http://localhost:8080/ |
| `JWT_SECRET` | Yes | Secret key used to sign and verify JSON Web Tokens (JWTs) for authentication. | JWT authentication will not work. | | `JWT_SECRET` | Yes | Secret key used to sign and verify JSON Web Tokens (JWTs) for authentication. | JWT authentication will not work. |
| `DB_NAME` | Yes | Name of the Postgres database to connect to. | Database connection will fail. | | `DB_NAME` | Yes | Name of the Postgres database to connect to. | Database connection will fail. |
| `DB_USER` | Yes | Username for Postgres database authentication. | Database connection will fail. | | `DB_USER` | Yes | Username for Postgres database authentication. | Database connection will fail. |