WhichFilm

Introduction

WhichFilm is a web application designed to help users decide which film to watch. By leveraging a comprehensive database of movies, user reviews, and ratings, WhichFilm provides personalized recommendations based on user preferences and viewing history.

Installation

To get started with WhichFilm, follow these steps:

1. Clone the repository:

git clone https://github.com/yourusername/whichfilm.git

2. Navigate to the project directory:

cd whichfilm

3. Install dependencies:

npm install

4. Set up environment variables: Create a .env file in the root directory and add the necessary environment variables:

DATABASE_URL=your_database_url
ORAMA_API_KEY=your_api_key

5. Run the application:

npm start

Technologies Used

WhichFilm is built using the following technologies:

• Frontend:

  • NextJS: A React framework for building fullstack applications.
  • TailwindCSS: For styling the application.

• Backend:

  • Orama Search: A high-performance, lightweight full-text search engine for fast and efficient indexing and querying of data.

• APIs:

  • The Movie Database (TMDb) API: For fetching movie data and metadata.

• Tools:

  • Git: For version control.
  • npm: For managing project dependencies.
  • dotenv: For managing environment variables.

Contributing

We welcome contributions to WhichFilm! If you would like to contribute, please follow these steps:

1. Fork the repository.
2. Create a new branch for your feature or bugfix.
3. Make your changes and commit them with a descriptive message.
4. Push your changes to your forked repository.
5. Create a pull request to the main repository.

License

This project is licensed under the MIT License. See the LICENSE file for more details.

Contact

If you have any questions or feedback, please feel free to reach out to us at [email protected].