Skip to content

README修正 #19

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mk10um merged 2 commits into from
Aug 16, 2020
Merged

README修正 #19

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
bc40778
fix readme
Aug 16, 2020
6ac5f4f
fix build
Aug 16, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
69 changes: 64 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,43 @@
# 概要
Goの学習を目的として作成したサイト。学習時間を記録することができるサービス。

デモサイト： https://www.learnmemo.net/

# 学習・実装済み事項
- Goのクリーンアーキテクチャの設計
- Goでのインテグレーションテスト・ユニットテスト
- OAuth認証
- SPA(nuxtjs)とサーバー(gin)の連携
- Terraformでのインフラ構築（Route53, ACM, Fargate, RDS）

# 機能
- OAuthSignUp、ログイン
- 学習記録のCRUD

# Goサーバーサイド構成

クリーンアーキテクチャで構成。

- xormのコードをinfrastructure内に隔離し、ライブラリ変更の障壁を下げる
- 同様にgin, gothのコードをinterface内に隔離

```
.
├── domain
│   ├── model
│   └── repository
├── infrastructure
│   ├── repository
│   └── router
├── interfaces
│   ├── auth
│   ├── controller
│   └── middleware
├── main.go
└── usecase
```


# 開発環境構築

```
Expand All @@ -9,13 +49,16 @@ cd docker/mysql_helper
## serverside

```
export ENV=dev; go run main.go
cd api
export ENV=dev
fresh -c recompile.conf
```
localhost:8080にアクセスすることでサーバー側の確認ができます。

### test
```
$ export DB_NAME="gin_test"; export ENV="test"; go test -v .
cd api
export DB_NAME="gin_test"; export ENV="test"; go test -v .
```

## frontend
Expand All @@ -30,12 +73,28 @@ yarn dev
# xorm

## reverse
DBのテーブル定義からmodelを生成する方法です。

```
$ xorm reverse mysql root:root@/gin?charset=utf8mb4 $GOPATH/src/github.com/go-xorm/cmd/xorm/templates/goxorm
```

# ref
# デプロイ
ローカルからデプロイする場合

1. Dockerイメージのビルド

```
cd frontend
yarn build
cd ../docker/production/api
./build.sh
```

2. イメージのデプロイ

```
cd deploy/learnmemo
ecspresso deploy --config=config.yaml
```

[Golang のパッケージ完全に理解した ← わかってない - くろのて](https://note.crohaco.net/2019/golang-package/)
[ginを最速でマスターしよう - Qiita](https://qiita.com/Syoitu/items/9e7e3215fb7ac9dabc3a)