From 5d83242fd66f632456bd8e2361ec8c48e1b15bae Mon Sep 17 00:00:00 2001 From: amhsirak Date: Sun, 3 Nov 2024 17:33:42 +0530 Subject: [PATCH] chore: example env --- README.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/README.md b/README.md index 3bff4816..da0f0527 100644 --- a/README.md +++ b/README.md @@ -55,6 +55,9 @@ You can access the frontend at http://localhost:5173/ and backend at http://loca # Environment Variables +1. Create a file named `.env` in the root folder of the project +2. Example env file can be viewed [here](https://github.com/getmaxun/maxun/blob/master/ENVEXAMPLE). + | Variable | Mandatory | Description | If Not Set | |-----------------------|-----------|----------------------------------------------------------------------------------------------|--------------------------------------------------------------| | `BACKEND_URL` | Yes | URL to run backend on. | Backend won't start. If not sure, set to http://localhost:8080/ |