https://github.com/ictsc/ictsc-rikka
score-server backend in ictsc
https://github.com/ictsc/ictsc-rikka
docker docker-compose go golang redis
Last synced: 6 months ago
JSON representation
score-server backend in ictsc
- Host: GitHub
- URL: https://github.com/ictsc/ictsc-rikka
- Owner: ictsc
- Created: 2021-06-17T12:20:50.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2024-11-05T12:43:43.000Z (over 1 year ago)
- Last Synced: 2024-11-16T00:42:12.059Z (over 1 year ago)
- Topics: docker, docker-compose, go, golang, redis
- Language: Go
- Homepage:
- Size: 354 KB
- Stars: 0
- Watchers: 7
- Forks: 0
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# ictsc-rikka
score-server backend in ictsc 2021 summer.
## development
`docker-compose`と`make`を利用して開発することができます。
### 設定ファイル
設定ファイルは`cmd/rikka`以下に作成します。
`config.yaml`、`config.docker.yaml`は`.gitignore`で指定されているため、`config.yaml.example`を元に作成して下さい。
```
# 設定ファイルの例
cmd/rikka/config.yaml.example
# make run(ローカル実行時)に使用します
cmd/rikka/config.yaml
# make run-docker(docker実行時)に使用します
cmd/rikka/config.docker.yaml
```
### Docker での開発
#### 初回
`.env` をコピーし `.env.dev` を作成します
```
cp .env .env.dev
```
docker を起動しデータベースを初期化します
```
make up
make mariadb-reset-db
```
### テスト環境の作成
`scripts/test_seed.sql` が実施されデータが投入された状態で起動します
```
cp scripts/docker-compose.override.yml .
make up
```
### compose.yml
| service | image | 用途 | 永続化 |
|---------|-----------------|-----------|------------------------|
| rikka | golang:1.16 | API | なし |
| mariadb | mariadb:10.5.10 | データベース | mariadb:/var/lib/mysql |
| redis | redis:6.2.4 | session 用 | なし |
| go | golang:1.16 | 開発時実行用 | go-pkg:/go/pkg |
### Makefile
以下のコマンドが使えます。
```
# ローカルでgo run実行
make run
# docker composeでgo run実行（非推奨）
make run-docker
# docker compose ps
make ps
# api, mariadb, redisを起動
make up
# api, mariadb, redis, goのコンテナとネットワークを削除
make down
# go build
make build
# go test
make test
# go generate
make generate
# mariadbにmysqlコマンドでログイン
make mariadb
# データベースのリセット(drop -> create)
make mariadb-reset-db
# redis-cliを起動
make redis-cli
# 自己署名証明書の作成
make self-signed-cert-and-key
```
## deploy
### Docker でのデプロイ
`.env` をコピーし `.env.prod` を作成します
```
cp .env .env.prod
```
docker を起動しデータベースを初期化します
```
docker compose -f compose.yml -f compose.prod.yml --env-file .env.prod up -d
```