Go Shell
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
activity
auto
defs
filestore
middleware
models
net
routes
services
testutils
util
.env.example
.gitignore
.travis.yml
.zappr.yaml
README.md
glide.lock
glide.yaml
main.go

README.md

charcoal logo

Build Status

golang backend responsible for persisting information to the database and providing an HTTP/JSON api for charcoal.ui client consumption.

For detailed information about the api, please see the API Docs.

Installing

This application relies on mysql for it's persistence layer; the migrations for the database can be found in the charcoal.db repository. For more detailed instructions on preparing your database, please refer to that project's readme.

After cloning this repository, it's dependencies can be installed using glide:

$ go get -u github.com/Masterminds/glide
$ glide install

You will also need to prepare a .env file at the root of the repository - an example can be seen here. The third party services required to run the application are:

  1. aws - s3 is used to store files uploaded by clients
  2. google - the google apis are used by the application for user authentication
  3. mailgun - the application provides an api endpoint for use w/ mailgun webhooks to process data