gogen
Command-line tool to generate GO services, applications and libraries with reusable logic.
IMPORTANT: This project has been superseded by: https://github.com/tecnickcom/gosrvlib
///////////////////////////////////////////////////////////////////////////////////////////
- category Tool
- author Nicola Asuni [email protected]
- copyright 2014-2020 Nicola Asuni - Tecnick.com LTD
- license MIT (see LICENSE)
- link https://github.com/tecnickcom/gogen
Description
This is a command-line tool to quickly generate GO services, applications and libraries with a common set of features and reusable logic.
For an equivalent project in Python please check PyGen.
Each GO project built with this tool adheres to the set of conventions detailed in the following articles:
- Software Naming
- Software Structure
- Software Versioning
- Software Configuration
- Software Logging Format
- Software Metrics
- Simple API JSON Response Format
- Software Automation
- Build Software with Docker
Each generated project is immediately functional and can be fully tested using the make qa command.
To understand the logic of the generated applications please start with the main.go file and follow the code.
Quick Start
This project includes a Makefile that allows you to test and build the project in a Linux-compatible system with simple commands.
All the artifacts and reports produced using this Makefile are stored in the target folder.
To see all available options:
make help
Usage
make new TYPE=app CONFIG=myproject.cfg
-
TYPE is the project type:
- lib : Library
- app : Command-line application
- srv : HTTP API service
-
CONFIG is the configuration file containing the project settings.
To create a new configuration please clone the default.cfg file and change the values.
All projects are creted inside the target directory and should be moved to the correct path inside the $GOPATH/src.
Features
Services (srv)
- Web HTTP(S) RESTful JSON API;
- Standard command line options;
- Multiple configuration options, including remote configuration via Consul, Etcd or Environmental variable;
- Logging;
- StatsD client to collect usage metrics;
- Unit tests;
- Makefile;
- Docker build;
- RPM, DEB and Docker packaging;
- Example Proxy endpoint;
- Backend examples in MySQL, MongoDB and ElasticSearch.
Applications (app)
- Standard command line options;
- Multiple configuration options, including remote configuration via Consul, Etcd or Environmental variable;
- Logging;
- Unit tests;
- Makefile;
- Docker build;
- RPM, DEB and Docker packaging.
Libraries (lib)
- Unit tests;
- Makefile;
- Docker build;