brizo

command module
v1.0.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 19, 2017 License: MIT Imports: 9 Imported by: 0

README

Brizo

wercker status codecov Code Climate Go Report Card

PAAS that runs on top of Kubernetes.

Development

You can configure the app for local development using a .env file in the root of the project. You should copy .env.example to .env to get started. The example file will have all of the required config with sensible defaults.

Local database

A test database is provided using Docker. The .env.example file provided is configured to connect to this database by default. To start the database [install Docker] for your machine and run

$ docker-compose up -d

This will start a database listening on localhost:33062 with the username root and password secret. It will also setup a database named brizo.

Database migrations

Migrations will run against the database when Brizo starts up. If the app is running in development mode (BRIZO_DEV=true) a subcommand is provided to control migrations.

$ go build
$ ./brizo migrate
$ ./brizo migrate --down
Local Kubernetes

You must have a Kubernetes cluster available for development. You can setup a quick test cluster locally using Minikube. The default environment in .env.example is configured to connect to a minikube cluster.

UI

The JS UI is isolated to the ui directory. See the UI Readme for development info.

Autoreload

You can use Fresh to serve and autoreload the service during development.

Install Fresh

$ go get github.com/pilu/fresh

Then run the app

$ fresh
Dependency management

Dependencies are managed using Govendor. For simpliciy in version management dependencies are committed with the repo.

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis
app
handlers/jsonutil
Package jsonutil provides support functions for dealing with json responses and specificially focuses on handling errors.
Package jsonutil provides support functions for dealing with json responses and specificially focuses on handling errors.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL