https://github.com/osafune-cho/coco-backend
みんなで授業を受けるためのサービス バックエンド
https://github.com/osafune-cho/coco-backend
go openapi
Last synced: 26 days ago
JSON representation
みんなで授業を受けるためのサービス バックエンド
- Host: GitHub
- URL: https://github.com/osafune-cho/coco-backend
- Owner: osafune-cho
- License: apache-2.0
- Created: 2023-09-11T05:48:26.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-09-14T14:12:11.000Z (over 2 years ago)
- Last Synced: 2024-11-14T13:45:08.402Z (about 1 year ago)
- Topics: go, openapi
- Language: Go
- Homepage: https://osafune-cho.github.io/coco-backend/
- Size: 106 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE-APACHE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# coco-backend
[](https://github.com/osafune-cho/coco-backend/actions/workflows/ci.yml)
[](https://github.com/osafune-cho/coco-backend/actions/workflows/deploy.yml)
[](https://github.com/osafune-cho/coco-backend/actions/workflows/generate-documents.yml)
GC59201 情報メディア創成特別講義Bで開発しているサービスのバックエンドです。
- [API server documentation](https://osafune-cho.github.io/coco-backend/)
## 開発
開発には以下のソフトウェアが必要です。
- Nix
- Niv
- Docker Compose
以下のコマンドで開発に必要なソフトウェアが入った環境に入ることができます。
```
nix-shell
```
## 実行
以下のコマンドを実行することで`result/bin/`以下にバックエンドの単一バイナリを得られます。
```
nix-build
```
実行時には環境変数の設定と`poppler-utils`に依存していることに注意してください。
必要な環境変数については`.envrc.example`を参考にしてください。
また、単に実行するだけであれば以下のコマンドを実行することでバックエンドのDockerイメージを入手できます。
```
docker pull ghcr.io/osafune-cho/coco:latest
```
設定については[docker-compose.yml](https://github.com/osafune-cho/coco-infrastructure/blob/main/docker/docker-compose.yml)を参考にしてください。
## ライセンス
- MIT
- Apache-2.0