NLW Valoriza

Allow to register common users and admin users, tags and compliments between users. The app has friendly errors, use JWT to logins, validation, also a simple versioning was made.

Table of Contents

• Installing
  • Configuring
    • SQLite
      • Migrations
    • .env
• Usage
  • Error Handling
    • Errors Reference
  • Pagination
    • Link Header
    • X-Total-Count
  • Bearer Token
  • Versioning
  • Routes
    • Requests
• Running the tests
  • Coverage report

Installing

Easy peasy lemon squeezy:

$ yarn

Or:

$ npm install

Was installed and configured the eslint and prettier to keep the code clean and patterned.

Configuring

The application use just one database: SQLite.

SQLite

Store all application data. For more information to how to setup your database see:

• typeorm

You can find the application's ormconfig.js file in the root folder.

Migrations

Remember to run the database migrations:

$ yarn ts-node-dev ./node_modules/typeorm/cli.js migration:run -- -d ./src/database/datasource.ts

Or:

$ yarn typeorm migration:run -- -d ./src/database/datasource.ts

See more information on TypeORM Migrations.

.env

In this file you may configure your database connection, JWT settings, app's port and an url to documentation (this will be returned with error responses, see error section). Rename the .env.example in the root directory to .env then just update with your settings.

Usage

To start up the app run:

$ yarn dev:server

Or:

npm run dev:server

Error Handling

Instead of only throw a simple message and HTTP Status Code this API return friendly errors:

{
  "statusCode": 400,
  "error": "Bad Request",
  "message": "Tag already exists",
  "code": 240,
  "docs": "https://github.com/DiegoVictor/nlw-valoriza#errors-reference"
}

Errors are implemented with @hapi/boom. As you can see an url to error docs are returned too. To configure this url update the DOCS_URL key from .env file. In the next sub section (Errors Reference) you can see the errors code description.

Errors Reference

Pagination

All the routes with pagination returns 20 records per page, to navigate to other pages just send the page query parameter with the number of the page.

• To get the third page of incidents:

GET http://localhost:3000/v1/users?page=3

Link Header

Also in the headers of every route with pagination the Link header is returned with links to first, last, next and prev (previous) page.

<http://localhost:3000/v1/tags?page=7>; rel="last",
<http://localhost:3000/v1/tags?page=4>; rel="next",
<http://localhost:3000/v1/tags?page=1>; rel="first",
<http://localhost:3000/v1/tags?page=2>; rel="prev"

See more about this header in this MDN doc: Link - HTTP.

X-Total-Count

Another header returned in routes with pagination, this bring the total records amount.

Bearer Token

A few routes expect a Bearer Token in an Authorization header.

You can see these routes in the routes section.

GET http://localhost:3000/v1/users?page=1 Authorization: Bearer <token>

To achieve this token you just need authenticate through the /sessions route and it will return the token key with a valid Bearer Token.

Versioning

A simple versioning was made. Just remember to set after the host the /v1/ string to your requests.

GET http://localhost:3000/v1/tags

Routes

Routes with Bearer as auth method expect an Authorization header. See Bearer Token section for more information.

Requests

• POST /session

Request body:

{
  "email": "[email protected]",
  "password": "123456"
}

• POST /users

Request body:

{
  "name": "John Doe",
  "email": "[email protected]",
  "password": "123456",
  "admin": true
}

• POST /tags

Request body:

{
  "name": "Inspiration",
}

• POST /compliment

Request body:

{
  "tag_id": "a7e96379-e1e0-4b01-954c-38175d3df012",
  "receiver_id": "38015cdf-c70a-420c-9efa-b71b8f7fae1e",
  "message": "Assumenda ducimus quia distinctio eaque"
}

Running the tests

Jest was the choice to test the app, to run:

$ yarn test

Or:

$ npm run test

Coverage report

You can see the coverage report inside tests/coverage. They are automatically created after the tests run.