Skip to content

joint-online-judge/horse

Repository files navigation

JOJ Horse

GitHub CI/CD GitHub branch checks state Codacy Badge Codacy Badge Swagger Badge

The new generation of JOJ Backend. "Horse" is related to speed, an excellent feature of the backend server. It is also a homophonic name in Chinese, aka, "后(horse)端"

Requirements

  • Python >= 3.8
  • PostgreSQL
  • Redis
  • LakeFS

Installation

You should use Docker container for development and production. Check https://github.com/joint-online-judge/joj-deploy-lite.

For Developers (and IntelliSense)

curl -sSL https://raw.githubusercontent.com/python-poetry/poetry/master/get-poetry.py | python - # install poetry
poetry install -E test
poetry run pre-commit install

Check http://127.0.0.1:34765/api/v1 for api documentation.

Checklist Before Commit

  • pre-commit is installed and passed
  • Update SQL tables:
docker exec -it horse poetry run alembic revision --autogenerate -m "<comments>"
docker exec -it horse poetry run alembic upgrade head

License

MIT