/koyofes-navi-backend

豊田工業高等専門学校の学校祭である「こうよう祭」で使用する各展示の待ち時間管理アプリのバックエンド

Primary LanguagePython

Koyofes Navi Backend

Overview

Koyofes Navi は、豊田工業高等専門学校で開催される文化祭「こうよう祭」における待ち時間管理システムです。

Getting Started

Prerequisites

Poetry

Pythonファイルの依存関係管理はpoetryを使用します。

  1. https://python-poetry.org/docs/#installation
  2. python -m venv venv
  3. source venv/bin/activate
  4. pip install --upgrade pip (必要であれば)
  5. poetry install

pre-commit (for developers)

commitする前に実行するコマンドを定義するツールです。.pre-commit-config.yaml に定義済みなので、それを各自の環境に設定する必要があります。下記手順で行ってください。

  1. https://pre-commit.com/#installation
  2. pre-commit install

Installation

  1. Clone this repository

     git clone https://github.com/kathmandu777/koyofes-navi-backend.git

  2. Build

    docker-compose build

  3. Setup Static Files

    docker-compose run fastapi poetry run python manage.py collectstatic --noinput

  4. Migrate

    docker-compose run fastapi poetry run python manage.py migrate

  5. Create Super User for Admin Page

    docker-compose run fastapi poetry run python manage.py createsuperuser

Usage

docker-compose up

alias for frequently used commands

source alias.sh