platform-app

command module
v0.0.0-...-6f95374 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 27, 2023 License: MIT Imports: 0 Imported by: 0

README

platform-app

GitHub go.mod Go version

document

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

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis
cmd
e2e
integration
internal
adapter/handler
Package handler is a generated GoMock package.
Package handler is a generated GoMock package.
application/usecase
Package usecase is a generated GoMock package.
Package usecase is a generated GoMock package.
domain/repository
Package repository is a generated GoMock package.
Package repository is a generated GoMock package.
domain/rpc
Package rpc is a generated GoMock package.
Package rpc is a generated GoMock package.
pkg
ent
log
openapi
Package openapi provides primitives to interact with the openapi HTTP API.
Package openapi provides primitives to interact with the openapi HTTP API.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL