Skip to content

Commit d9e1d70

Browse files
committed
docs: add deployment and development documentation
1 parent 69f1a58 commit d9e1d70

File tree

2 files changed

+106
-0
lines changed

2 files changed

+106
-0
lines changed

docs/deployment.md

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
# デプロイ
2+
3+
## 前提条件
4+
5+
- サーバーに Docker と Portainer がインストールされていること
6+
- Tailscale の Auth Key (`tskey-auth-...`) を取得済みであること([Tailscale Admin Console](https://login.tailscale.com/admin/settings/keys)
7+
- GitHub Container Registry のパッケージ公開設定
8+
- GitHub Actions が初回実行された後、GitHub のパッケージ設定(Packages -> Package Settings)で、`Visibility``Public` に変更してください。
9+
10+
## デプロイ手順
11+
12+
1. Portainer にログイン
13+
2. Stacks メニューを開き、Add stack をクリック
14+
3. Name に `kc3hack-2026-team14` 等を入力
15+
4. Build method で Repository を選択
16+
- Repository URL: このリポジトリの URL
17+
- Repository reference: `refs/heads/main` (または `develop`)
18+
- Compose path: `docker-compose.prod.yml`
19+
5. Environment variables を設定
20+
21+
```env
22+
DEBUG=False
23+
SECRET_KEY=django-insecure-CHANGE_ME
24+
ALLOWED_HOSTS=localhost,127.0.0.1,[::1],.ts.net
25+
26+
# Database
27+
POSTGRES_DB=kc3hack_db
28+
POSTGRES_USER=kc3hack_user
29+
POSTGRES_PASSWORD=change_this_password
30+
POSTGRES_HOST=db
31+
POSTGRES_PORT=5432
32+
33+
# MinIO
34+
MINIO_ROOT_USER=minio_admin
35+
MINIO_ROOT_PASSWORD=change_this_password
36+
MINIO_BUCKET_NAME=kc3hack-bucket
37+
MINIO_ENDPOINT_URL=http://minio:9000
38+
39+
# Tailscale
40+
TS_AUTHKEY=tskey-auth-xxxxx
41+
TS_HOSTNAME=kc3hack-team14
42+
```
43+
44+
6. Deploy the stack をクリック
45+
46+
## アクセス確認
47+
48+
Tailscale Admin Console で機器が接続されたことを確認し、発行された URL にアクセスしてください。
49+
例: `https://kc3hack-team14.tailnet-name.ts.net`

docs/development.md

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
# 開発環境のセットアップ
2+
3+
## 前提条件
4+
5+
- Python 3.14 以上
6+
- uv
7+
- Docker Engine + Docker Compose
8+
- GDAL / GEOS ライブラリ (GeoDjango用)
9+
- Ubuntu/Debian: `sudo apt-get install gdal-bin libgdal-dev`
10+
- macOS: `brew install gdal`
11+
- Windows: OSGeo4Wインストーラーなどを使用してください
12+
13+
## リポジトリのクローン
14+
15+
```bash
16+
git clone git@github.com:kc3hack/2026_team14.git
17+
cd 2026_team14
18+
```
19+
20+
## セットアップ
21+
22+
```bash
23+
uv run poe setup
24+
```
25+
26+
### 管理ユーザーの作成
27+
28+
セットアップ完了後、必要に応じて管理ユーザー(Django Superuser)を作成してください。
29+
これを作成すると、[http://127.0.0.1:8000/admin/](http://127.0.0.1:8000/admin/) から管理画面にログインしてデータを操作できます。
30+
31+
```bash
32+
uv run python manage.py createsuperuser
33+
```
34+
35+
## 開発の再開
36+
37+
一度セットアップをした後、開発を再開する場合は以下の手順で起動します。
38+
39+
### インフラの起動
40+
```bash
41+
docker compose up -d
42+
```
43+
44+
### サーバーの起動
45+
```bash
46+
uv run poe dev
47+
# または
48+
uv run python manage.py runserver
49+
```
50+
51+
### アクセス
52+
53+
#### Web
54+
- [http://127.0.0.1:8000](http://127.0.0.1:8000)
55+
56+
#### MinIO Console
57+
- [http://127.0.0.1:9001](http://127.0.0.1:9001) (u: `minio_admin`, p: `minio_password`)

0 commit comments

Comments
 (0)