You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
36 lines
590 B
36 lines
590 B
3 years ago
|
# SETUP
|
||
|
|
## DEPENDENCIES
|
||
|
|
- install dependencies with
|
||
|
|
```
|
||
|
|
npm install
|
||
|
|
npm install --only=dev
|
||
|
|
```
|
||
|
|
|
||
|
|
## DATABASE
|
||
|
|
Create the database using the .sql file
|
||
|
|
|
||
|
|
Run the migrations with:
|
||
|
|
```
|
||
|
|
npx sequelize-cli db:migrate
|
||
|
|
```
|
||
|
|
|
||
|
|
Run the seeders with:
|
||
|
|
```
|
||
|
|
npx sequelize-cli db:seed:all
|
||
|
|
```
|
||
|
|
|
||
|
|
## CONFIGURATION
|
||
|
|
**Configure the server port in the .env file.**
|
||
|
|
|
||
|
|
**Database configuration is in config/config.json file.**
|
||
|
|
|
||
|
|
# API
|
||
|
|
## START THE SERVER
|
||
|
|
You can start the server with the following command :
|
||
|
|
```
|
||
|
|
npm run dev
|
||
|
|
```
|
||
|
|
|
||
|
|
## SWAGGER
|
||
|
|
You should use the swagger available at **`http://localhost:<port>/api-docs`.**
|