https://github.com/go-bootstrap/go-bootstrap

Generates a lean and mean Go web project.
https://github.com/go-bootstrap/go-bootstrap

Last synced: 30 days ago
JSON representation

Generates a lean and mean Go web project.

• Host: GitHub
• URL: https://github.com/go-bootstrap/go-bootstrap
• Owner: go-bootstrap
• License: mit
• Created: 2015-05-06T16:26:17.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2020-05-31T17:48:35.000Z (over 4 years ago)
• Last Synced: 2024-09-30T22:20:51.509Z (about 1 month ago)
• Language: Go
• Homepage: http://go-bootstrap.io
• Size: 375 KB
• Stars: 1,596
• Watchers: 45
• Forks: 106
• Open Issues: 9
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
[![GoDoc](https://godoc.org/github.com/go-bootstrap/go-bootstrap?status.svg)](http://godoc.org/github.com/go-bootstrap/go-bootstrap)

[![license](http://img.shields.io/badge/license-MIT-red.svg?style=flat)](https://raw.githubusercontent.com/go-bootstrap/go-bootstrap/master/LICENSE.md)

## go-bootstrap

This is not a web framework. It generates a skeleton web project for you to kick-ass.

Feel free to use or rip-out any of its parts.

**NOTE:** Due to lack of Windows machine, at the moment, PostgreSQL template is not working on Windows.

## Prerequisites

1. PostgreSQL or MySQL if you choose to use a database.

1. Go programming language, version 1.3.x or newer.

1. Ensure `$GOPATH/bin` is in your `$PATH`. Example: `PATH=$PATH:$GOPATH/bin`

## Installation

1. `go get github.com/go-bootstrap/go-bootstrap`

1. `$GOPATH/bin/go-bootstrap -dir github.com/{git-user}/{project-name} -template {core|postgresql|mysql}`

1. Start using it: `cd $GOPATH/src/github.com/{git-user}/{project-name} && go run main.go`

## PostgreSQL Environment Variables

If you have `PGUSER`, `PGPASSWORD`, `PGHOST`, `PGPORT`, `PGSSLMODE` environment variables set,

they will be used to generate and bootstrap the database.

## Decisions Made for You

This generator makes **A LOT** of decisions for you. Here's the list of things it uses for your project:

1. There are 3 templates to choose from:

    * Core: If you don't want a database.

    * PostgreSQL.

    * MySQL.

1. bcrypt is chosen as the password hasher.

1. Bootstrap Flatly is chosen for the UI theme.

1. Session is stored inside encrypted cookie.

1. Static directory is located under `/static`.

1. Model directory is located under `/models`.

1. It does not use a full blown ORM.

1. Test database is automatically created under `$GO_BOOTSTRAP_PROJECT_NAME-test`.

1. A minimal Dockerfile is provided.

1. A minimal Vagrantfile is provided.

1. [github.com/jmoiron/sqlx](https://github.com/jmoiron/sqlx) is chosen to connect to a database.

1. [github.com/gorilla](https://github.com/gorilla) is chosen for a lot of the HTTP plumbings.

1. [github.com/carbocation/interpose](https://github.com/carbocation/interpose) is chosen as the middleware library.

1. [github.com/tylerb/graceful](https://github.com/tylerb/graceful) is chosen to enable graceful shutdown.

1. [github.com/rnubel/pgmgr](https://github.com/rnubel/pgmgr) is chosen as the database migration and management tool for PostgreSQL.

1. [github.com/mattes/migrate](https://github.com/mattes/migrate) is chosen as the database migration and management tool for MySQL.

1. [github.com/Sirupsen/logrus](https://github.com/Sirupsen/logrus) is chosen as the logging library.

1. [github.com/spf13/viper](https://github.com/spf13/viper) is chosen to manage application config.