README.md

Kinopoisk on Django

• Description
  • Short
  • Full
• Getting Started
  • Prerequisites
  • Install & Run project
  • Seed data
    • Base (Top 250 kinopoisk movies)
    • Add movie from kinopoisk
    • Generate movie score
• Built With
• Contributing
  • Code Style
  • Tasks
  • Branch naming
• Authors
• License
• Environment variables

Description

Short

Aggregator of movies

Full

A clone of kinopoisk.
At the moment, the user can view information about movies and persons,
watch news

Getting Started

Prerequisites

1. Python3
2. PostgreSQL
3. Minio

Install & Run project

1. Clone repo

git clone https://github.com/Pogchamp-company/kinopoisk_on_django.git

2. Create Python Virtual Environment
3. Install requirements

pip install -r requirements.txt

4. Create PostgreSQL database
5. Set env variables
6. Migrate database

# cd src
manage.py migrate

7. Run minio

# cd ..
docker-compose up -d minio

8. Initialize Minio buckets

manage.py initialize_buckets

9. Collect static files

manage.py collectstatic

10. Optional: run seeds
11. Run project

manage.py runserver

Seed data

Base (Top 250 kinopoisk movies)

1. Generate seeders json or download this in release
2. Run

manage.py loaddata seed/movies.json
manage.py loaddata seed/persons.json

3. Get posters
4. Run

manage.py load_posters
manage.py load_photos

Add movie from kinopoisk

YOUR_API_KEY

Run

manage.py add_kp_movie {movie_id} --api-key {YOUR_API_KEY}

Generate movie score

Run

manage.py seed_users {users_count}
manage.py seed_scores

Run tests

!Warning: seed data before running tests

bash run_tests.sh

Built With

• Django - The web framework used
• Django Rest Framework - Rest api utils

Contributing

Code style

pep8

Tasks

• Trello Desk

Branch naming

{username}/{task_short_description}

Authors

• Roman Alexandrov - Documentation, Backend - Github
• Artem Golovin - Backend - Github
• Sergey Sirotkin - Main frontend developer - Github

License

This project is licensed under the MIT License - see the LICENSE.md file for details

Environment variables

Variable	Short description	Default
SECRET_KEY	App session secret key	@oowa+)%q57uxhffto99*-b+mt%63!@r&#17mqstv&%fr92*
DATABASE_URI	PostgreSQL connection URI	postgresql+psycopg2://postgres@localhost:5432/KOD
MINIO_ENDPOINT	Endpoint to connect minio	127.0.0.1:9001
MINIO_ACCESS_KEY	Minio user	minio
MINIO_SECRET_KEY	Minio password	minio123
MINIO_USE_HTTPS	-	False