/disney-API

This API allows you to manage information about Disney Characters, Movies and Genres. First of all you need to register to start using the API.

Primary LanguageJavaScript

Disney API

An API to manage Disney characters, movies and genres.

Avaible methods:

  • characters: GET | GET by ID | POST | PUT by ID | DELETE by ID
  • movies: GET | GET by ID | POST | PUT by ID | DELETE by ID
  • genres: GET | POST | PUT by ID | DELETE by ID
  • user: LOGIN | REGISTER

Documentation

To see the API documentation, click on the following link: Postman

Run Locally

Clone the project

  git clone https://github.com/oconsl/disney-API.git

Install dependencies

  npm i

Create the database with psql:

  psql -U postgres

  CREATE DATABASE disney;

Create and configure .env file on root folder with the following environment variables:

USER=postgres (default)

HOST=localhost

DB=Database name (disney)

PASSWORD=User DB password

PORT=5432 (default)

SERVER_PORT=3000 (default)

JWT_SECRET=Secret to encode JWT

SENDGRID_API_KEY=API Key provided by sendGrind

OWNER_EMAIL=Sender Email for sendGrid

Start the server

  npm start

Running Tests

Before running the tests, add the following environment variable to .env file, it must be a valid token provided by /auth/login endpoint:

TEST_TOKEN=Bearer token

After that to run tests, run the following command after creating the database successfully:

  npm test

Tech Stack

Node Express SendGrid PostgreSQL Sequelize JWT JOI Express-jwt Mocha Chai Bcrypt

Author