typical-rest-server

Typical-RESTful-Server

Example of typical and scalable RESTful API Server for Go

Prerequisite

1. Go (It is recommend to install via Homebrew brew install go)

Build

Use ./typicalw build to build the project.

Use ./typicalw run to build and run the project.

Use ./typicalw test to execute the unit testing.

Learn more about Build Tool

Application

Modules

Docker

Commands:

• ./typicalw docker compose: Generate docker-compose.yaml
• ./typicalw docker up: Spin up docker containers
• ./typicalw docker down: Take down all docker containers

Server

Postgres

Commands:

• ./typicalw postgres create: Create New Database
• ./typicalw postgres drop: Drop Database
• ./typicalw postgres migrate: Migrate Database
• ./typicalw postgres rollback: Rollback Database
• ./typicalw postgres seed: Database Seeding
• ./typicalw postgres console: PostgreSQL Interactive

Redis

Commands:

• ./typicalw redis console: Redis Interactive

Release Distribution

Use ./typicalw release to make the release. You can find the binary at release folder.

Learn more Release Distribution