TypeScript + Node.js Movies REST API (WIP)

🔝 Project

An API to find your next movie or create your watch list. It include reviews, rating, actors and anything you need to know about the movie.

• This application will help users find their next movie to watch by showing helpful stats

☑️ Requirements

• Node.js installed, version 10.13 or later
• Docker installed, version 19.03.12 or later
• Docker Compose installed, version 1.24.1 or later

🚧 Start Development Server

• Copy env vars

$ cp .env.example .env

• Start API

$ npm run dev
# OR DIRECTLY VIA DOCKER COMPOSE
$ docker-compose up

📰 API Documentation

• Create Documentation

$ npm run doc:create

• Open Documentation

$ npm run doc:open

📌 Routes

• ❗ IMPORTANT: All movies routes will be return Movie entities.

Method	Path	Type of Return
GET	/v1/movies/	Movie[]
GET	/v1/movies/:id	Movie

💀 Run Tests

Unit tests:

$ npm run test:unit

💾 Backlog

User Stories

• User can see all movies on a page
• User can see all movies ordered by their release date
• User can see any movie on a separate page

Bonus features

• User can create an account
• User can create their own watch list
• User can make movie review
• Authorization
  • Admin user can create/update/delete a movie

💻 Author

• Rafael Dias ⛄ - Software Developer

🔧 Contributing

If you find any problem or have a suggestion, please open an issue.

💡 Credits for the ideia

• APP Ideas - MovieDB