Peter_Computerliebe_ORG/battleship
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Sparsh Goenka
2024-09-28 13:20:57 +05:30
committed by GitHub
parent 1916ad332b
commit 8a1b9bf603
1 changed files with 6 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@@ -13,6 +13,12 @@ The client is built using SvelteKit (static site) and the server uses Axum frame
The client can be started using `npm run dev` inside `app` directory. The client can be started using `npm run dev` inside `app` directory.
The server and the database services are containarized. Just run `docker compose up` to start the server and database services if you are working on the frontend. The server and the database services are containarized. Just run `docker compose up` to start the server and database services if you are working on the frontend.
Make sure to make a `.env` file with these parameters:
```
DATABASE_PASSWORD=db_password
DATABASE_NAME=db_name
DATABASE_URL=postgres://postgres:db_password@localhost:5432/db_name
```
If you are working on the server, you can run `cargo watch -i app -x run` to automatically restart the server when the source code changes, and `docker compose up -d db` to start the database service in the background. If you are working on the server, you can run `cargo watch -i app -x run` to automatically restart the server when the source code changes, and `docker compose up -d db` to start the database service in the background.