Skip to content
This repository has been archived by the owner on Jul 15, 2023. It is now read-only.

cangkevin/SEAshows

Repository files navigation

SEAshows

Mainline status Coverage Status Codacy Badge

What is SEAshows?

SEAshows is a small project that serves as a hub for east-asian shows and programming.

Current content that is supported:

  • HK Dramas
  • HK Variety and News
  • HK Movies
  • Chinese Dramas
  • Chinese Movies
  • Korean Dramas
  • Korean Movies
  • Taiwanese Dramas

SEAshows's user experience is targeted towards a particular demographic, particularly those who are not computer-savvy. There is future work planned to make the site more feature-rich for navigation and searching.

Local development

Environment setup

This projects uses pipenv. It is recommended to install pipenv via pipx.

python3 -m pip install --user pipx
python3 -m pipx ensurepath
pipx install pipenv

Once pipenv is installed, install the project's virtual environment and dependencies.

pipenv install --dev

Install the project's pre-commit hooks.

pipenv run pre-commit install

Create a .env file at the root of the project with the following:

FLASK_APP=seashows.py
FLASK_ENV=development
SECRET_KEY=dev
BASE_URL=<SOURCE URL>
ELASTICSEARCH_URL=http://localhost:9200

where <SOURCE_URL> is the remote data source.

Finally, activate the virtual environment.

pipenv shell

Running the project

To run the development server

flask run

Conventions

This project adheres to conventional commits for the commit message. This is intended to drive the automated versioning strategy for the application based on the messages in the commit history.