Responsible for provide data to the web and mobile front-ends. Permit to register your class availability and subject, also count the number of teacher connected to users (get contacted by whatsapp). The app has validation and a simple versioning was made.

• 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

Easy peasy lemon squeezy:

$ yarn

Or:

$ npm install

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

The application uses just one database: SQLite. For the fastest setup is recommended to use docker-compose, you just need to up all services:

$ docker-compose up -d

Store all the users, classes and connections. For more information to how to setup your database see:

• knexfile.ts

You can find the application's knexfile.ts file in the root folder.

Remember to run the SQLite database migrations:

$ yarn knex:migrate

Or:

$ npx knex migrate:latest

See more information on Knex Migrations.

In this file you may configure the environment, your app's port and a 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.

For more information about the MAIL_* keys configurations see nodemailer website, since this project uses it to mail.

To start up the app run:

$ yarn dev:server

Or:

npm run dev:server

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

{
  "statusCode": 429,
  "error": "Too Many Requests",
  "message": "Too Many Requests",
  "code": 529,
  "docs": "https://github.com/DiegoVictor/proffy-api#errors-reference"
}

Errors are implemented with @hapi/boom. As you can see a 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.

All the routes with pagination returns 10 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:3333/v1/classes?page=3

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:3333/v1/classes?page=7>; rel="last",
<http://localhost:3333/v1/classes?page=4>; rel="next",
<http://localhost:3333/v1/classes?page=1>; rel="first",
<http://localhost:3333/v1/classes?page=2>; rel="prev"

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

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

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

You can see these routes in the routes section.

GET http://localhost:3333/v1/classes 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.

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

GET http://localhost:3333/v1/classes

• POST /sessions

Request body:

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

• POST /connections

Request body:

{
  "user_id": 76988
}

• POST /classes

Request body:

{
  "user_id": 76988,
  "whatsapp": "39379976591",
  "bio": "I have been worked with PHP/Laravel and JavaScript/Node.js for +4 years. Recently I started studying ReactJs and React Native :)",
  "cost": 30,
  "subject": "Node.js",
  "schedule": [
    {
      "week_day": 0,
      "from": "10:00",
      "to": "15:00"
    },
    {
      "week_day": 4,
      "from": "7:00",
      "to": "11:00"
    }
  ]
}

• POST /users

Request body:

{
  "name": "John",
  "surname": "Doe",
  "email": "[email protected]",
  "password": "123456",
  "avatar": "https://cloudflare-ipfs.com/ipfs/Qmd3W5DuhgHirLHGVixi6V76LhCkZUz6pnFt5AJBiyvHye/avatar/1103.jpg",
  "whatsapp": "1125585262",
  "bio": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. ",
}

• POST /users/forgot_password

Request body:

{
  "email": "[email protected]"
}

• POST /users/reset_password

Request body:

{
  "password": "123456",
  "password_confirmation": "123456",
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyLCJpZCI6IjE4ZjZkNzYzLTQ1NWMtNDEwNC1iMmFlLWUwNzE2N2JhOTMwYyJ9.uqiIJHRc6wsNCBy3MVtO-hDWwvs_afIhv7adswrUas4"
}

• POST /favorites

Request body:

{
  "user_id": 76988
}

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

$ yarn test

Or:

$ npm run test

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