golang_startup

module

v0.6.0 Latest Latest Go to latest Published: Apr 15, 2022 License: GPL-3.0

Details

Golang basic web application structure using an onion architecture approach.

Before to run application you may setup .env with Config values. Check out the following tables to know all Config parameters detailed.

Parameter	Description	Type	Required
`DB_ADDRESS`	Database URL address.	`string`	YES
`DB_NAME`	Name of the initial database to access.	`string`	NO
`MIGRATIONS_PATH`	Migrations local path if needed.	`string`	NO
`HOST`	HTTP server host number.	`string`	NO
`PORT`	HTTP server port number.	`string`	YES

After define env variables values, run the following commands to start web application server.

The different examples of running this application packages and features are available in cmd.

For a REST application with a postgres database layer use:

go run ./cmd/postgres/main.go

For an application with MySQL database layer use:

go run ./cmd/mysql/main.go

For an application with MongoDB database layer use:

go run ./cmd/mongo/main.go

Path	Synopsis
cmd
mongo command
mysql command
postgres command
internal
common Package common holds useful code to be used across all package and layers.	Package common holds useful code to be used across all package and layers.
config Package config holds configuration global data to be initialized.	Package config holds configuration global data to be initialized.
controller Package controller holds application controllers.	Package controller holds application controllers.
database/mongodb Package mongodb holds MongoDB database and repository methods.	Package mongodb holds MongoDB database and repository methods.
database/mysql Package mysql holds MySQL database and repository methods.	Package mysql holds MySQL database and repository methods.
database/postgres Package postgres holds PostgreSQL database and repository methods.	Package postgres holds PostgreSQL database and repository methods.
model Package model holds domain model structs and methods.	Package model holds domain model structs and methods.
server Package server holds server related struct and methods.	Package server holds server related struct and methods.
service Package service holds service layer methods and repository/database abstractions.	Package service holds service layer methods and repository/database abstractions.