zobweyt / kpk

A movie database web service

kpk

kpk is a movie database web service. It is an open-source project, allowing all of the community's members to contribute and see their code live in action.

Table of Contents

1. Key Features
2. Getting Started
3. Contribution

Key Features

• Manage movies and reviews.
• Leave reviews for movies.
• Configure admins via the control panel.

Getting started

Clone the repository:

git clone https://github.com/zobweyt/kpk.git

Install common project dependencies locally:

pip install -r requirements/common.txt

Create an .env file in the root directory and configure the environment variables:

SECRET_KEY="SECRET_KEY"
SQLALCHEMY_DATABASE_URI="sqlite:///db.sqlite3"

Create a superuser:

flask create-superuser <username> <password> <email>

Finally, run the website:

flask --debug run

Contribution

Feel free to open an issue, contribute or suggest new ideas to improve this repository!

Install project dependencies required for development locally:

pip install -r requirements/dev.txt

Before committing, run static analysis tools in the project root directory:

black .