pudymody/tvtracker

A movies and tv show tracker for personal use

Table of Contents

• About the Project
• Getting Started
  • Prerequisites
  • Installation
• Usage
• Roadmap
• Contributing
• License
• Contact
• Acknowledgements

About The Project

Track your movies and tv shows using TMDB API as a webapp.

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

• Node
• npm
• An TMDB Api key

Installation

1. Clone the repo

git clone https://github.com/pudymody/repo.git

2. Install NPM packages

npm install

3. Setup TMDB api key in index.js file

const TMDB_KEY = "API_KEY";

4. Start node server

node server

Usage

There exists the following routes

• / List all watched shows and movies, and unfinished
• /tv/:id Show a single tv show thats in the database
• /tv/:id/add Adds the tv show to the database
• /movie/:id Show a single movie thats in the database
• /movie/:id/add Adds the movie to the database

Roadmap

• Add episode runtime
• Add show and movie genres
• Year in a review?
• Statistics?

Acknowledgements

• TMDB
• Sqlite

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

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

License

Distributed under the GPL-3.0 License. See LICENSE for more information.

Contact

Federico Scodelaro - @pudymody - federicoscodelaro@gmail.com