Added differenciation between local and docker based testing/dev setup
This commit is contained in:
parent
60c1b5d748
commit
860b6c850d
36
README.md
36
README.md
@ -3,17 +3,45 @@
|
|||||||
Backend Server
|
Backend Server
|
||||||
|
|
||||||
## Dev Setup 🛠
|
## Dev Setup 🛠
|
||||||
|
|
||||||
|
### Local w/ sqlite
|
||||||
|
|
||||||
|
1. Create a .env file in the project root containing:
|
||||||
|
```
|
||||||
|
APP_PORT=4010
|
||||||
|
DB_TYPE=sqlite
|
||||||
|
DB_HOST=bla
|
||||||
|
DB_PORT=bla
|
||||||
|
DB_USER=bla
|
||||||
|
DB_PASSWORD=bla
|
||||||
|
DB_NAME=./test.sqlite
|
||||||
|
```
|
||||||
|
2. Install Dependencies
|
||||||
|
```bash
|
||||||
|
yarn
|
||||||
|
```
|
||||||
|
3. Start the server
|
||||||
|
```bash
|
||||||
|
yarn dev
|
||||||
|
```
|
||||||
|
|
||||||
|
### Docker w/ postgres 🐳
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
docker-compose up --build
|
docker-compose up --build
|
||||||
```
|
```
|
||||||
|
|
||||||
## Recommended Editor
|
## Recommended Editor
|
||||||
|
|
||||||
[Visual Studio Code](https://code.visualstudio.com/)
|
[Visual Studio Code](https://code.visualstudio.com/)
|
||||||
|
|
||||||
### Recommended Extensions
|
### Recommended Extensions
|
||||||
|
|
||||||
- will be automatically recommended via ./vscode/extensions.json
|
- will be automatically recommended via ./vscode/extensions.json
|
||||||
|
|
||||||
## File Structure
|
## File Structure
|
||||||
- src/models/* - database models (typeorm entities)
|
|
||||||
- src/controllers/* - routing-controllers
|
- src/models/\* - database models (typeorm entities)
|
||||||
- src/loaders/* - loaders for the different init steps of the api server
|
- src/controllers/\* - routing-controllers
|
||||||
- src/routes/* - express routes for everything we don't do via routing-controllers (shouldn't be much)
|
- src/loaders/\* - loaders for the different init steps of the api server
|
||||||
|
- src/routes/\* - express routes for everything we don't do via routing-controllers (shouldn't be much)
|
||||||
|
Loading…
x
Reference in New Issue
Block a user