goat

README

About:Goat

Goat is a simple golang: application template builder.

Generate template of your application, via chosen templates:

• Message brokers:
  • RabbitMQ - consumer or publisher via https://github.com/streadway/amqp;
• Databases:
  • Postgres - database via https://github.com/go-pg + migrations;
  • MySQL - database via github.com/go-sql-driver/mysql + migrations;
  • ClickHouse - database via github.com/kshvakov/clickhouse + migrations;
• Web-Servers:
  • HTTP - http server via https://golang.org/pkg/net/http;
• Metrics:
  • Prometheus - prometheus endpoint GET /metrics via https://github.com/prometheus/client_golang;

Installation

Just get it

go get -u github.com/spyzhov/goat

Basic usage

Change dir to targeted, run goat and answer for several questions.

user@user:/go/src/github.com/spyzhov/example$ goat
Project path [/go/src/github.com/spyzhov/example]? [Y/n]: y 
Project name [example]? [Y/n]: y
Repository name [github.com/spyzhov/example]? [Y/n]: y
Use Postgres connection (github.com/go-pg)? [y/N]: y
Use Postgres migrations (github.com/go-pg/migrations)? [y/N]: y
Use MySQL connection (github.com/go-sql-driver/mysql)? [y/N]: y
Use MySQL migrations (github.com/rubenv/sql-migrate)? [y/N]: y
Use ClickHouse connection (github.com/kshvakov/clickhouse)? [y/N]: y
Use ClickHouse migrations (github.com/golang-migrate/migrate)? [y/N]: y
Select WebServer?
 2) Use FastHTTP server (github.com/valyala/fasthttp)?
 1) Use HTTP server (net/http)?
 0) No one...
Please, select [0-2]: 1 
Use Prometheus (github.com/prometheus/client_golang)? [y/N]: y
Use RMQ-consumer (github.com/streadway/amqp)? [y/N]: y
Use RMQ-publisher (github.com/streadway/amqp)? [y/N]: y
Select AWS Lambda?
 7) Use SQS Events?
 6) Use SNS Events?
 5) Use SES Events?
 4) Use S3 Events?
 3) Use Config Events?
 2) Use API Gateway?
 1) Use Simple?
 0) No one...
Please, select [0-7]: 7

And you will got :

├── app
│   ├── app.go
│   ├── config.go
│   ├── consumer.go
│   ├── http.go
│   ├── lambda.go
│   ├── lambda_handle.go
│   ├── logger.go
│   └── publish.go
├── Dockerfile
├── Gopkg.toml
├── main.go
├── migrations
│   ├── 01_init.go
│   ├── clickhouse
│   │   ├── 1-init.down.sql
│   │   └── 1-init.up.sql
│   ├── mysql
│   │   └── 1-init.sql
│   ├── clickhouse.go
│   ├── mysql.go
│   ├── postgres.go
│   └── source
│       └── packr
│           └── packr.go
├── README.md
└── signals
    └── signals.go

Use dep

The best and quickest way to start:

user@user:/go/src/github.com/spyzhov/example$ goat
...
user@user:/go/src/github.com/spyzhov/example$ dep ensure
...
... Profit!

License

MIT licensed. See the LICENSE file for details.

TODO

• Misc:
  • validation for path/name/etc.;
  • remove code "noodles" - make module append methods;
  • normalize migrations;
  • add context & WaitGroups;
  • add help / description for every type of templates;
  • add example-templates;
  • remove vendor dependencies;
  • add colors for a dialog;
• Libraries:
  • add choice for http clients:
    • native;
    • fasthttp;
    • echo;
  • add Redis support "github.com/gomodule/redigo/redis";
  • add clear TCP connect support;
  • switch Postgres to "github.com/lib/pq": "v1.0.0"
• Dependencies:
  • add dep support;
  • add go mod support;
  • add versions for libs;
• Service type:
  • daemon;
  • console;