README
¶
Typical-RESTful-Server
Example of typical and scalable RESTful API Server for Go
Getting Started
Prerequisite
- Install Go or
brew install go
Run
Use ./typicalw run to compile and run local development. You can find the binary at bin folder
Release Distribution
Use ./typicalw release to make the release. You can find the binary at release folder. More information check here
Configuration
| Key | Type | Default | Required | Description |
|---|---|---|---|---|
| APP_ADDRESS | String | :8089 | true |
Server
| Key | Type | Default | Required | Description |
|---|---|---|---|---|
| SERVER_DEBUG | True or False | false |
Postgres Database
| Key | Type | Default | Required | Description |
|---|---|---|---|---|
| PG_DBNAME | String | true |
Directories
¶
| Path | Synopsis |
|---|---|
|
EXPERIMENTAL
|
|
|
cmd
|
|
|
app
command
|
|
|
test-parser
command
|
|
|
typical-dev-tool
command
|
|
|
typical-generator
command
|
|
|
Package mock is a generated GoMock package.
|
Package mock is a generated GoMock package. |
|
pkg
|
|
|
utility/timekit
Package timekit provide error safe function for time function
|
Package timekit provide error safe function for time function |
Click to show internal directories.
Click to hide internal directories.