/tmdb-app

Primary LanguageTypeScript

Forks Stargazers Issues

LinkedIn


Logo

TMDB App

Know your next movie!
Explore the docs »

· Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgements

About The Project

Using the TMDB API, we can get lots of information about movies. Allied to an awesome interface, we are now sharing a way to know information about the trending movies.

Built With

This project was built using:

Getting Started

The following steps are the description of how you can set up the project locally.

Prerequisites

You'll need to have yarn installed to install the required packages.

yarn

You'll also need Node.js installed. Download it from the link below.

Node.js

Installation

  1. Clone the repository

     git clone https://github.com/victorprnt/tmdb-app.git
  2. Install yarn packages

     yarn
  3. To execute the project locally, run the following command:

     yarn start
  4. You should access the app through

    http://localhost:3000

Usage

Browsing trending movies

Just by scrolling down, you can run through a list of the trending movies on the platform, according to other users. You can also click on one of these movies and obtain more information about it.

Searching a movie

There is an area where you can search for a movie. The search is done after you finish typing the name of the movie you are looking for. The search will return a list with the first 20 movies that matches most your search

Roadmap

See the open issues for a list of proposed features (and known issues).

Go to the project tracker on Notion

Contributing

Any contributions you would like to do are greatly appreciated.

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/NewFeature)
  3. Commit your Changes (git commit -m 'Comment about the NewFeature created')
  4. Push to the Branch (git push origin feature/NewFeature)
  5. Open a Pull Request

Contact

Victor Parente - LinkedIn - victorprnt@gmail.com

Project Link: https://github.com/victorprnt/tmdb-app