Getting Started

Frontend

1. Clone repository

git clone https://github.com/brain-flowing-company/psuechaokhai-backend.git

2. Start backend server

docker-compose up -d --build --no-deps # note: frontend only

3. pgAdmin is available at localhost:5050

Field	Value
pgAdmin Username	[email protected]
pgAdmin Password	admin
Host name/address	db
Port	5432
Username	postgres
Password	123456

Backend

Prerequisite

• Golang
• Makefile (optional)
• docker
• git
• swagger

1. Clone repository

git clone https://github.com/brain-flowing-company/psuechaokhai-backend.git

2. Copy .env.example to .env

3. Get Swagger cli

go install github.com/swaggo/swag/cmd/swag@latest

4. Run development server

docker-compose -f docker-compose.dev.yaml up -d --build --no-deps # note: backend only
# or
make up

5. pgAdmin is available at localhost:5050

Field	Value
pgAdmin Username	[email protected]
pgAdmin Password	admin
Host name/address	db
Port	5432
Username	postgres
Password	123456

Note: make sure you have Makefile before using make command

• This will automatically start postgres database and development server with auto-reload.
• Swagger (API docs) is at localhost:8000/docs *change port if your app is running on different port
• If you've made any changes to API docs (comments above handler function), make sure you run this command to update API docs page.

swag init -g ./cmd/main.go -o ./docs/
# or
make docs

Project structures

• cmd/ contains main.go
• config/ contains env var loader
• database/ contains database (postgres) connector
• internal/
  • name folder by service name (snake_case)
  • .handler.go handles http request
  • .service.go holds core logic
  • .repository.go holds data fetcher (database queries or external api calls)

Contribution

1. Make sure to pull the latest commit from dev branch

git pull origin dev

2. Create new branch with your git GUI tools or use this command

git checkout -b <branch-name>

3. Make sure you on the correct branch
4. Craft your wonderful code and don't forget to commit frequently

git add <file-path> # add specific file
# or
git add . # add all files

git commit -m "<prefix>: <commit message>"

Note: check out commit message convention

5. Push code to remote repository
6. Create pull request on github

• compare changes with base: dev ← compare: <branch-name>
• title also apply commit message convention
• put fancy description

Commit message convention

git commit -m "<prefix>: <commit message>"

• use lowercase
• meaningful commit message

Prefix

• feat: introduce new feature
• fix: fix bug
• refactor: changes which neither fix bug nor add a feature
• chore: changes to the build process or extra tools and libraries