学習型RSS

Project Summary

Item	Description
Lang	Go v1.16
WAF	Gin v1.6.3
Database	MySQL 8.0
ORM	SQLBoiler
Application Architecture	Clean Architecture
CI (Lint & Test)
CD (Deploy on XXX)	CircleCI

Get Started

Build and run containers

We're using docker-compose for development.

$ cd paddle/
$ docker-compose build

Afterwards, you can stop and up docker-compose as usual.

$ docker-compose up
$ docker-compose stop

Setup Database

Preparation

$ make dc-preparation

Run migrations

$ make dc-migrate

Insert demo data

$ docker exec -it paddle_go_1 sh -c "mysql -h paddle_db_1 -u apuser -ppassword -D paddle < scripts/demodata.sql"

Create a migration file

# Run this at the root directory, please.
$ docker-compose run go migrate create -ext sql -dir db/migrations xxx(migration title)

Affect a new schema after running migration

$ make dc-generate-orm

Branch Model

Github Flow

Pull Request Merge Conditions

You can merge Pull Request when the following conditions are fulfilled.

• PR should be approved by at least 2 reviewers.
• The status checks, such as lint and test, should be passed.

For more details, see the following protection rules.

How to deploy

TBD

CI/CD Pipeline

You have to set EC2 connection key, GitHub deployment key, and the variables below in the CircleCI's Project Settings.

• EC2 connection key: the key you get or set in creating an EC2 Instance.
• GitHub deployment key: the key you can set in the GitHub's Project Settings.

Environment Key	Description
USERNAME	EC2 Username
HOST	EC2 Hostname or IP Address
SSH_PORT	EC2 SSH Port
AWS_ACCESS_KEY_ID	AWS Acceess Key
AWS_SECRET_ACCESS_KEY	AWS Secret Access Key
AWS_REGION	AWS Region