xevion/linkpulse
1
0
Fork 0
mirror of https://github.com/Xevion/linkpulse.git synced 2025-12-08 16:07:39 -06:00
Code Issues Packages Projects Releases Wiki Activity

Add run.sh warning note to README

Browse Source
This commit is contained in:
Xevion
2024-11-01 01:06:43 -05:00
parent af91adeca3
commit cb76965a43
1 changed files with 3 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
README.md
View File

@@ -72,6 +72,9 @@ A full stack (*frontend* and *backend*), automatically reloading project is poss
2. Execute `./run.sh` to start the development server for each.
- For the backend, you'll either need to have the `railway` CLI installed or a `.env` file with the database URL.
- See [`.env.example`](backend/.env.example) for a list of all available environment variables.
- For the frontend, the defaults are already sufficient.
>[!WARNING] The `run.sh` scripts provide default environment variables internally; if you want to run the commands manually, you'll need to provide them to `.env` files or the command line.
[peewee]: https://docs.peewee-orm.com/en/latest/
[railway]: https://docs.railway.app/guides/cli