An open API service indexing awesome lists of open source software.

https://github.com/saitamau-maximum/maxitter


https://github.com/saitamau-maximum/maxitter

twitter-clone

Last synced: 2 months ago
JSON representation

Awesome Lists containing this project

README

          

# Maxitter

MaximumメンバーがWeb研究部の活動として、Twitterのようなマイクロブログサービス作りを通して共同開発・Webアプリケーション開発の経験を積むことを目的としたプロジェクトです。

## 開発環境

- Docker (Docker Compose)
- Nginx
- MySQL (db)
- Go (back)
- React (front)

## 開発形態

- ブランチモデル
- production (本番環境)
- development (ステージング環境)
- feat/xxx (機能追加)
- fix/xxx (バグ修正)
- hotfix/xxx (緊急バグ修正)

## 開発手順

### 最初

1. リポジトリをクローンする `git clone https://github.com/saitamau-maximum/maxitter.git`
2. `cd maxitter`でフォルダに移動
3. `cp .env.example .env`で.envファイルを作成
4. `.env`ファイルを自分の好きな名前やパスワードに書き換え
5. `./scripts/setup.sh` でビルドしてコンテナを起動する

### 停止

`./scripts/stop.sh` でコンテナを停止する

### 再開

`./scripts/start.sh` でコンテナを再開する

### DBデータの削除

`./scripts/reset-db.sh` でDBデータを削除する

### デプロイ

`./scripts/deploy.sh` で本番環境にデプロイする
(マイグレーションなど特別なオペレーションが必要な場合もある)

## スプリント

毎週月曜日にあるWeb研究会の講義の間を1スプリントと定義する。

## バージョニング

バージョンは1スプリントでマイナーバージョン x.X.x を上げることにする。
それよりも細かい単位の変更 (スプリント中だけど緊急で修正箇所が浮上したなど)でリリースが必要な場合、パッチバージョン x.x.X を上げることにする。

メジャーバージョンに関しては区切りが良くなったタイミングであげるで良い。