diff --git a/README.md b/README.md index b0cecb9..75c18dc 100644 --- a/README.md +++ b/README.md @@ -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 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.