Skip to content

Latest commit

 

History

History
46 lines (38 loc) · 1.99 KB

README.md

File metadata and controls

46 lines (38 loc) · 1.99 KB

RESTful API

How to use?

$ git clone https://github.com/Synrgy-Academy-Final-Project/Backend-FSW.git  # get source code of the repository
$ cp .env.example .env                                                       # copy file .env.example to .env
$ npm install                                                                # install package

Scripts

$ npm run build                                                                 # build typescript project
$ npm run dev                                                                   # run in development mode
$ npm run setup                                                                 # run migration, seeder
$ npm run knex migrate:up filename.ts                                           # run migration specific filename
$ npm run knex migrate:down filename.ts                                         # drop migration specific filename
$ npm run knex migrate:make migration_name                                      # create new file migration
$ npm run knex seed:make seed_name                                              # create new file seeds
$ npx knex seed:run --specific=filename.ts --knexfile src/config/knexfile.ts    # run seed specific filename
$ npm run keys                                                                  # create private and public key jwt, no passphrase
$ npm run test                                                                  # run unit test
$ npm run coverage                                                              # run unit test with coverage
$ npx vitest tests/folder/filename.test.ts                                      # run test with specific file

Account Login Admin

{
    "email": "[email protected]",
    "password": "mizz"
},
{
    "email": "[email protected]",
    "password": "dharmawan"
}

Run Management Tools for PostgreSQL

$ docker-compose up -d          # run container pgadmin4
$ docker-compose down -v        # delete container pgadmin4 and the volume