development.md

Development

This document explain how to develop fascia.

Environment Variables

Create file .docker-env, and write follwing environments:

DATABASE_URL=mysql                      ## MySQL docker host name
DB_USER=root
DB_PASSWORD=mysql                       ## This is specified by docker-compose.yml
DB_NAME=fascia
DB_TEST_NAME=fascia_test
CLIENT_ID=hogehoge                      ## GitHub application client id
CLIENT_SECRET=fugafuga                  ## GitHub application client secret key
TEST_TOKEN=testhoge                     ## GitHub access token for test environments
SLACK_URL=https://hooks.slack.com/services/hogehoge/fugafuga

Docker

Development environment for fascia require Docker and Docker Compose, so you will need them. Please install Docker and Docker Compose.

JavaScript

It's necessary to prepare node packages, so please run npm install in docker container.

$ docker-compose run --rm node /bin/bash
node@b8446c2db58c:/var/opt/app$ npm install

Server Application

Then, you can run docker container.

$ docker-compose run --rm --service-ports go /bin/sh

Please install dependent packages using dep.

$ dep ensure

At first time, you need to create database, like this:

$ mysql -u root -h mysql
mysql > create database fascia char set utf8mb4;

And prepare database tables.

$ goose up
$ go run main.go seed

After that, you can start server.

$ go run main.go server

Please open browser and access localhost:9090, you can access fascia on localhost.