CircleCI postgres redis nodemon eslint airbnb-style jest coverage MIT License PRs Welcome
Run in Insomnia}

Responsible for provide data to the web and mobile front-ends. Allow users to create their meetups' and/or subscribe to from other users. The app has, pagination, pagination's link header (to previous, next, first and last page), friendly errors, use JWT to logins, validation, also a simple versioning was made.

• Installing
  • Configuring
    • .env
    • Redis
    • Postgres
      • Migrations
      • Seed
• 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 two databases: Postgres and Redis. For the fastest setup is recommended to use docker-compose, you just need to up all services:

$ docker-compose up -d

In this file you may configure your Redis database connection, JWT settings, the environment, 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.

Responsible to store data utilized by the mail queue. If for any reason you would like to create a Redis container instead of use docker-compose, you can do it by running the following command:

$ docker run --name meetapp-redis -d -p 6379:6379 redis:alpine

Responsible to store all application data. If for any reason you would like to create a Postgres container instead of use docker-compose, you can do it by running the following command:

$ docker run --name meetapp-postgres -e POSTGRES_PASSWORD=docker -p 5432:5432 -d postgres

Remember to run the Postgres database migrations:

$ npx sequelize db:migrate

Or:

$ yarn sequelize db:migrate

See more information on Sequelize Migrations.

Optionally you can fill the database with some random data:

$ npx sequelize db:seed:all

Or:

$ yarn sequelize db:seed:all

To start up the app run:

$ yarn dev:server

Or:

npm run dev:server

Also the application has a mail queue, to setup it just remember to run:

$ npm run queue

Or:

$ yarn queue

The mail queue send emails to meetups' owner notifying when a user subscribes to it

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

{
 "statusCode": 401,
 "error": "Unauthorized",
 "message": "Token not provided",
 "code": 441,
 "docs": "https://github.com/DiegoVictor/meetapp-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 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 meetups:

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

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

• POST /session

Request body:

{
 "email": "johndoe@example.com",
 "password": "123456"
}

• POST /users

Request body:

{
 "email": "johndoe@example.com",
 "name": "John Doe",
 "password": "123456"
}

• PUT /users

Request body:

{
 "name": "John Doe",
 "email": "johndoe@example.com",
 "old_password": "123456",
 "password": "123456789",
 "confirm_password": "123456789"
}

• POST /files

Image file

• POST /meetups

Request body:

{
 "banner_id": 1,
 "date": "2020年12月30日",
 "description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit.",
 "localization": "4795 Denesik Throughway Kaileefurt, NC 07927-4723",
 "title": "Creative Planner"
}

• PUT /meetups

Request body:

{
 "banner_id": 1,
 "date": "2020年12月31日",
 "description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit.",
 "localization": "64504 Stehr Motorway Tellyfort, IL 33915-6894",
 "title": "Lead Quality Director"
}

• PUT /subscriptions

Request body:

{
 "meetup_id": 1,
}

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.