Akvo Flow data change events service
Clojure HTML CSS Shell
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
dev
doc
provision
resources
src/akvo_reflow
test
.gitignore
.travis.yml
LICENSE
README.md
profiles.clj.template
project.clj

README.md

akvo-reflow Build Status

FIXME: description

Developing

Setup

When you first clone this repository, run:

lein setup

This will create files for local configuration, and prep your system for the project.

Environment

To begin developing, start with a REPL.

lein repl

Then load the development environment.

user=> (dev)
:loaded

First time init the DB

user=> (migrate)
[0]

Run go to initiate and start the system.

dev=> (go)
:started

By default this creates a web server at http://localhost:3000.

When you make changes to your source files, use reset to reload any modified files and reset the server.

dev=> (reset)
:reloading (...)
:resumed

Testing

Testing uses lein-test-refresh. Open a terminal in the project root and enter

lein test-refresh

This will run the tests and automatically re-run the tests as soon as a file is changed.

Of course you can also run tests directly in Leiningen.

lein test

Generators

This project has several generator functions to help you create files.

To create a new endpoint:

dev=> (gen/endpoint "bar")
Creating file src/foo/endpoint/bar.clj
Creating file test/foo/endpoint/bar_test.clj
Creating directory resources/foo/endpoint/bar
nil

To create a new component:

dev=> (gen/component "baz")
Creating file src/foo/component/baz.clj
Creating file test/foo/component/baz_test.clj
nil

Deploying

FIXME: steps to deploy

Legal

Copyright © 2016 FIXME