Warning
This project is in early development and not yet functional.
Cinemix is a streamlined app for effortless discovery of movies and shows.
Report a Bug
·
Request a Feature
·
View Contribution Guide
Cinemix is a backend-focused project designed to simplify and optimize the discovery of movies and TV shows through efficient data retrieval and processing. It interacts with external APIs to provide structured, searchable media data while maintaining speed, reliability, and scalability. This project serves as a learning platform for building robust backend services that handle real-world constraints like API limits and performance bottlenecks.
Core Philosophy:
- Rate Limiting: Ensures compliance with API usage restrictions while preventing service slowdowns by controlling request frequency.
- Caching: Stores frequently accessed data to reduce redundant API calls, improve response times, and enhance overall system efficiency.
- Advanced Search: Enables quick and flexible querying of movie and TV show data for more relevant and precise results.
To get a local copy up and running, follow these simple steps.
Make sure you have Python 3.8+ and UV installed on your system.
- Install UV:
curl -LsSf https://astral.sh/uv/install.sh | sh
- Clone the repository to your local machine:
-
git clone https://github.com/Homies-Tech-Innovation/cinemix.git cd cinemix
- Install the required Python packages using UV:
-
uv sync
- Set up your environment variables by copying the sample file:
-
cp .env.sample .env
- Run the app:
-
uv run -m src.main
Caution
This project is in active development. Expect frequent updates and possible instability.
- Usage will be documented once the project's stable version is released.
Outline future plans and features for the project.
- MVP: Simple search for movies and shows with caching and rate limiting.
- v2: User accounts with Auth and wishlisting shows and movies.
See the open issues for a full list of proposed features (and known issues).
Contributions are the lifeblood of open source. Any contributions you make are greatly appreciated. Please read our Contribution Guide for details on our code of conduct and the process for submitting pull requests.
Distributed under the MIT License. See LICENSE file for more information.
- External API used: Cinemix is heavily dependent on the API, and we really appreciate its generous free tier.
