FilmDB

Keep forgetting what you've been meaning to watch? Create your own community and plan a watch party!
View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Why
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

This is FilmDb, a full-stack web app designed for communities to keep track of watch parties.

(back to top)

Why

As a member of many online communities, I've noticed there's been a rise in online watch parties. Whether you are a twitch streamer or just want to keep track of the movies you've watched with your friend group, this is the place to be. I wanted a way to be able to not only track watch requests, but to also schedule and rate them.

Built With

• 
• Prisma
• Mantine UI
• Tabler Icons
• MongoDB
• TMDB API for movie and tv show info

(back to top)

Getting Started

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

Prerequisites

• install pnpm

  npm install pnpm

  OR

  npm install -g @pnpm/exe

• This project uses Next-Auth for authentication. Follow the docs in order to set up the OAuth providers.

  Here are the providers used in this project:

  • Auth0
  • Discord
  • Google

Installation

1. Clone the repo

   git clone https://github.com/kirontoo/filmdb.git

2. Install packages

   pnpm install

3. Grab your TMDB API key at TMDB
4. Create a .env.local file and add all of your keys. See the .env.example file for all envirnment variables that you'll need. For the NEXTAUTH_SECRET, generate a 256-bit secrety key.
5. Run npx prisma generate

(back to top)

Roadmap

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

(back to top)

Contributing

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

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

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

(back to top)

License

Distributed under the MIT License. See LICENSE for more information.

(back to top)

Contact

Amy Nguyen-Dang - ndangamy@gmail.com

Project Link: https://github.com/kirontoo/filmdb

(back to top)

Acknowledgments

(back to top)