Skip to content

Latest commit

 

History

History
111 lines (84 loc) · 4.02 KB

README.md

File metadata and controls

111 lines (84 loc) · 4.02 KB

Welcome to Reelwatch 🎬

Version Documentation Maintenance License: MIT

Reelwatch is where your movie watchlist dreams come to life! Built with love using Next.js, TypeScript, Tailwind CSS, and powered by Appwrite Cloud, we're here to bring you an enthralling experience tailored for movie buffs. Dive into a world where your favorite films are just a search away and creating a personal watchlist is easier than ever.

🌟 Features

  • Endless Movie Search: Powered by the TMDB API, find your next movie gem in a snap.
  • Your Watchlist: Curate a personal list of must-watch movies.
  • Flawless on Any Screen: Designed to look and work perfectly on any device.
  • Secure User Experience: Log in confidently with top-notch security.

Homepage

🚀 Getting Started

Prerequisites

  • npm >=5.5.0
  • node >=12.0.0 (Recommended: Use the Latest LTS Version)
  • yarn >= 3.6.0
  • An account on Appwrite.io for backend services

🛠 Installation

  1. Clone the project to get started: Get the code on your local machine and install its dependencies.

    git clone https://github.com/timDeHof/movie-nextjs-app.git
    cd movie-nextjs-app
  2. Install dependencies:

    npm install
    # or if you use yarn
    yarn
  3. Set up your environment: Duplicate .env.local.template to .env.local and fill it with your keys.

    NEXT_PUBLIC_APPWRITE_ENDPOINT="[APPWRITE_ENDPOINT]"
    NEXT_PUBLIC_APPWRITE_PROJECT_ID="[APPWRITE_PROJECT_ID]"
    NEXT_PUBLIC_APPWRITE_SERVER_API_KEY="[APPWRITE_SERVER_API_KEY]"
    NEXT_PUBLIC_APPWRITE_DATABASE_ID="[APPWRITE_DATABASE_ID]"
    NEXT_PUBLIC_APPWRITE_COLLECTION_ID="[APPWRITE_COLLECTION_ID]"
    NEXT_PUBLIC_TMDB_MOVIE_KEY="[TMDB_MOVIE_KEY]"
  4. Fire up the development server: Launch the app and explore it on your local machine.

    npm run dev
    # or with yarn
    yarn dev

Visit http://localhost:3000 to see your application running.

🧪 Testing

Run the test suite to ensure everything is set up correctly:

npm test
# or
yarn test

💡 Contributing

Got ideas on how to make Reelwatch even better? We're all ears! Check out our contributing guide for more info on submitting pull requests.

✨ Show your support

Loved Reelwatch? Give it a ⭐️! If you need help or want to suggest features, feel free to open an issue on the issues page

🙌 Meet the Creator

👤 Tim DeHof

📝 License

Copyright © 2023 Tim DeHof.
This project is MIT licensed.


This README was generated with ❤️ by readme-md-generator