Skip to content

yods/kixi.hecuba

 
 

Repository files navigation

Hecuba

A data platform built with Clojure, ClojureScript, core.async, Om, Cassandra and other technologies.

Build Status

Build Status

Usage

To start the server, clone the repo, and then lein repl or cider-jack-in as you prefer

(go)

When you make changes just reset.

(reset)

Then you'll need to compile the clojurescipt. That can be done with cljsbuild like this

lein cljsbuild auto hecuba

This will recompile your clojurescript each time you save. The server app needs to be bounced by doing reset as above.

If you pull from github, you'll still probably want to restart your nrepl session though.

To clean the build do:

lein clean

This will delete both clj and cljs from target and out directories.

You can also use figwheel: Instead of running lein cljsbuild auto hecuba and reloading the website, update project.clj to have this:

:env {:is-dev true}

and run:

lein figwheel hecuba

Each time you save your cljs files, figwheel will recompile and refresh the website for you.

Environment should be set to {:is-dev false} before deployment to the server. For production deployment please compile once:

lein cljsbuild once hecuba

To run Clojure tests do:

lein test

To run ClojureScript tests:

lein cljsbuild test

Dev environment

We are using Vagrant to manage dev environments.

  • Install VirtualBox v4.3.28 (correct as of 10th June 2015) from here or preferably via your OS's package manager.
  • Install Vagrant v. 1.7.2 (correct as of 10th June 2015) from here or preferably via your OS's package manager.
  • install the vbguest plugin so Virtual Box guest additions will updated for you vagrant plugin install vagrant-vbguest
  • cd ${PROJECT_HOME}
  • vagrant up (This will download stuff the first time and will be slow, after that it will be quicker)
  • You will now have all the services required running in a virtual machine with the ports forwarded for access from your local machine

First Time Test Data

  • Log into the vagrant box using vagrant ssh
  • Copy the contents of hecuba-schema.sql onto the box you've ssh'd into using vi or similar.
  • create the test schema cqlsh kixi-dev -f hecuba-schema.sql
  • Start cqlsh with the right hostname cqlsh kixi-dev

Back on your host machine do the following:

  • Start a repl in your favourite way.
  • Start the application with (go)
  • (require 'etl)
  • (etl/load-user-data) to create the users
  • (etl/load-csv system) to add some test programmes, projects, etc

Start an EC2 instance

  • make sure you have foreman installed
  • add the aws plugin vagrant plugin install vagrant-aws
$ gem install foreman
  • copy env.example into .env and edit your AWS credentials in there
  • foreman run vagrant up --provider=aws

Support

Hecuba is a new project which is being developed 'in the open'. Therefore it may not work exactly as described in these notes. Hecuba is not (yet) a released and supported code-base, rather it is being made available for others as a learning aid. Please bear this in mind when contacting the team, raising issues and submitting pull requests.

References

License

Copyright © 2014 Mastodon C Ltd

Distributed under the Eclipse Public License version 1.0.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Clojure 65.2%
  • Ruby 23.4%
  • HTML 9.2%
  • Shell 1.1%
  • Python 0.4%
  • CSS 0.4%
  • Other 0.3%