docs: Details in README

Signed-off-by: Tibo De Peuter <tibo.depeuter@ugent.be>
This commit is contained in:
Tibo De Peuter 2025-02-23 22:11:15 +01:00
parent 9bd7696c7b
commit 2030b97c21
Signed by: tdpeuter
GPG key ID: 38297DE43F75FFE2
9 changed files with 129 additions and 9 deletions

22
backend/README.md Normal file
View file

@ -0,0 +1,22 @@
# dwengo-1-backend
## Project setup
```shell
npm install
```
Setup the environment variables in a `.env` file in the root of the project. You can use the `.env.example` file as a template.
### Development
```shell
npm run dev
```
### Production
```shell
npm run build
npm run start
```