platform-app

README

platform-app

document

• api
• database
• proto

directory structure

.
├── api                 // open api schema
├── cmd                 // application entry point
├── e2e                 // e2e test
├── integration         // integration test
├── internal            // main application code
├── pkg                 // auto generate code
├── proto               // proto schema
└── vendor              // vendor code

four layered architecture (internal directory)

.
├── domain
│   ├── model           // domain model include id
│   ├── value           // value object
│   ├── repository      // interface domain model persistence 
│   ├── cache           // interface domain model volatilization
│   └── rpc             // interface domain model remote procedure call
├── application
│   ├── interactor      // implements usecase
│   └── usecase         // interface
├── adapter
│   ├── controller      // core adapter
│   ├── gateway         // core adapter (implements repository)
│   ├── handler         // api adapter
│   ├── kvs             // api adapter (implements cache)
│   └── external        // api adapter (implements rpc)
└── driver
    ├── config
    ├── connect
    ├── cookie
    ├── cors
    ├── postgres
    ├── firebase
    ├── env
    ├── http
    ├── interceptor
    ├── middleware
    ├── newrelic
    ├── redis
    ├── router
    └── server

commit message prefix

Create an issue and include the number in the PREFIX when implementing.

PREFIX	meaning
feat(#x)	A new feature
fix(#x)	A bug fix
docs(#x)	Documentation only changes
style(#x)	Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
refactor(#x)	A code change that neither fixes a bug nor adds a feature
perf(#x)	A code change that improves performance
test(#x)	Adding missing or correcting existing tests
chore(#x)	Changes to the build process or auxiliary tools and libraries such as documentation generation

reference

local development setup

.env is required to Makefile.
.env file is prepared to switch the port number in each developer's environment.

touch .env
make env

make dev