/movie-rest-api

Primary LanguageJavaScriptMIT LicenseMIT

REST API for storing favourite movies

Simple rest api with great features.

Tech

This project uses a number of open source projects to work properly:

  • Express - Fast node.js network app framework
  • node.js - Evented I/O for the backend
  • JWT - Industry standard RFC 7519 method for representing claims securely between two parties.
  • Sequelize - Promise-based Node.js ORM for MySQL Server.
  • Axios - Promise based HTTP client for the browser and node.js.
  • Pino - Very low overhead Node.js logger.
  • Bcryptjs - Hashing information securely and rapidly.
  • MySQL2 - Database

And of course this project itself is open source with a public repository on GitHub.

Running server locally

Clone or download the project to your local machine. Specify the arguments in the .env file in the root of the project. Below is a sample .env file. Copy and paste the following fields. Specify the arguments.

PORT=3000
DB_NAME=[MYSQL DB NAME]
DB_USERNAME=[MYSQL DB USERNAME]
DB_PASS=[MYSQL DB PASS]
DB_HOST=localhost
LOG_LEVEL=info
JWT_SECRET=awesome_secret
OMDB_API_KEY=[OMDB API KEY]
BASE_URL=localhost:3000

then run the following commands.

npm install
npm run dev

Documentation

Full documentation can be found here.

License

MIT