typical-rest-server

module
v0.7.0 Latest Latest
Warning

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

Go to latest
Published: Aug 26, 2019 License: MIT

README

Typical-RESTful-Server

Example of typical and scalable RESTful API Server for Go

Getting Started

Prerequisite
  1. 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
PG_USER String postgres true
PG_PASSWORD String pgpass true
PG_HOST String localhost
PG_PORT Integer 5432

Directories

Path Synopsis
EXPERIMENTAL
git
app
cmd
app command
test-parser 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

Jump to

Keyboard shortcuts

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