https://github.com/nutfes/lottery
学籍番号抽選会アプリ
https://github.com/nutfes/lottery
clean-architecture docker docker-compose fastapi go gorm nfc-card-reader python tailwindcss typescript websocket
Last synced: 2 months ago
JSON representation
学籍番号抽選会アプリ
- Host: GitHub
- URL: https://github.com/nutfes/lottery
- Owner: NUTFes
- Created: 2021-08-03T09:51:27.000Z (almost 5 years ago)
- Default Branch: develop
- Last Pushed: 2023-05-13T22:32:27.000Z (about 3 years ago)
- Last Synced: 2026-01-12T20:26:56.009Z (5 months ago)
- Topics: clean-architecture, docker, docker-compose, fastapi, go, gorm, nfc-card-reader, python, tailwindcss, typescript, websocket
- Language: Go
- Homepage:
- Size: 182 MB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 学籍番号抽選会アプリ
Raspberry Pi と NFC 端末で学生証を読み取り，学籍番号を用いて抽選を行うシステム
抽選は会場で行うが，WebSocket によってスマホでの確認も可能
## 背景
## 構成
## 今後の展望
---
## 開発手順
### 1. クローン
```bash
git clone git@github.com:NUTFes/lottery.git
```
### 2. ビルド
```bash
# ビルド
docker compose build
docker compose run --rm api poetry install
docker compose run --rm app npm install
docker compose run --rm nfc poetry install
# lottery.dbがあれば，削除
sudo rm api/lottery.db
# テーブル作成
docker compose run --rm api python create_table.py
# 立ち上げ
docker compose up
```
### 3. 開発
issue に応じて，`dev/`でブランチを切ってそのブランチで開発してください
```bash
# 例
git switch -c dev/issue123
```
### 4. add, commit, push
- コミットはコミットメッセージの書式にしたがってください。
- プッシュは今いるブランチと同じ名前の場所にプッシュしてください。
```bash
# add
git add
# commit
git commit -m ""
# push
git push origin
```
#### commit メッセージの書式
- ファイルを追加したとき
`git commit -m "[add] 内容 (#)"`
- ファイルを変更したとき
`git commit -m "[mod] 内容 (#)"`
- ファイルを削除したとき
`git commit -m "[del] 内容 (#)"`
- 例
`git commit -m "[mod] 学籍番号の送信書式をJSONに変更 (#12)"`
### 5. Pull Request
- 確認してほしい点を明記してプルリクを書いてください
### 6. ER 図
