Poeta

全体として

プライベートなメモモード(コア機能)

各機能について

ログイン機能

[x] メールアドレス・パスワード認証
[x] Twitter 認証
[x] GitHub 認証
[x] Google アカウント認証
[ ] Instagram 認証(優先度低)
[ ] Facebook 認証(優先度低)

投稿機能関連

TIL (Markdown) のCRUD

[x] TIL 作成機能
[x] TIL 編集機能
[x] TIL 削除機能
[x] TIL 管理機能

言語実行機能関連

担当: ロピタル

[ ] コード実行機能
[ ] コード保存機能？

実装方法

create アクションなどにとばして、そこで以下のことを行う

入力されたコードをファイル(code.rb)に保存
Dockerfile に書き込む(code.rb をコンテナ内に持っていく)
コンテナ起動(volume オプションをつけて起動)
コンテナ上でコード実行(実行結果をファイル(result.txt)に書き込む(リダイレクトと言う)
コンテナとイメージ破棄
ホスト側に保存された実行結果をインスタンス変数に格納して画面に出力する

Docker コンテナ起動方法

コンテナのビルド

docker-compose build

コンテナの立ち上げ

docker-compose up

各コンテナの中に入る

APIコンテナ

docker-compose run api sh

フロントコンテナ

docker-compose run front sh

環境構築

# コンテナ立ち上げ
$docker-compose up -d

# DB テーブル作成
$docker-compose run api rails db:create

# DB マイグレーション
$docker-compose run api rails db:migrate

# フロント ライブラリインストール
$docker-compose run front npm install

Git Commit Guidelines

コミットメッセージのプレフィックス例

prefix	内容
feat	新機能
fix	バグの修正
docs	ドキュメント修正
style	コード内容に影響を与えない変更例. white-space, formatting, missing semi-colons
refactor	リファクタリングバグの修正も機能の追加も行わないコード変更
perf	パーフォマンスを向上させるための変更
test	テストの追加・修正
chore	雑用ビルドに関する変更やドキュメント生成のような変更
wip	作業中

バックエンド開発フロー

Repsonaに実行するタスクを貼る
タスクごとにブランチを切って作業する
その作業でエンドポイントが増えたらその都度API仕様書に追記する、記法が独特なので既存コードをコピペして文面や値だけ変えるのが分かりやすい。追記が終わったら最後にHTML形式へ整形する。

npm install -g aglio # aglioがインストールされていなければ

aglio -i poeta_api.apib -o poeta_api.html # html形式に整形

ブランチをmasterにpush、レビューはslackでバックエンド担当の別メンバーにお願いする。

開発

開発中のメールの確認

http://localhost:3000/letter_opener にアクセスすることで送信されたメールの確認ができる。

aiirononeko / languageMemoApp

readme