Microservice that offers a API REST to create and query users.
- NPM
7.0.3 - NodeJS
v15.0.1 - postgresql
Migrations are a way to make database changes or updates, like creating or dropping tables, as well as updating a table with new columns with constraints via generated scripts. We can build these scripts via the command line using knex command line tool.
- Creating migration
$ knex migrate:make <name_migration>
- Run migrations
$ knex migrate:latest
- Rollback migration
$ knex migrate:rollback
- Develop installation
1. Download repository.
2. Run command npm install on project root.
- Run locally using
.env.localor.env.testingfor set local environment variables
$ export $(cat .env.local | grep -v ^# | xargs)
$ knex migrate:latest // run migrations
$ npm run dev
- If you want to use docker
$ make api
This microservice implements two forms of authentication:
-
API_KEY
This way of authenticating is done through a parameter called API_KEY that is sent in the request header. Its use is more oriented to communication with other microservices.
-
BEARER TOKEN
This is an authentication with login in which the credentials of some user are verified in the database and, if correct, a token is generated. This token contains the user information in an encrypted form using the JWT standard.
- Run locally using
$ npm test
- If you want to use docker
$ make test
This microservice use airbnb linter
- Run lint to fix syintax problems
$ npm run lint