A picture game for helping children learn to read
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
ansible
dev
resources/bild_ord
scripts
src
test/bild_ord
.gitattributes
.gitignore
README.md
Vagrantfile
build-basscss.sh
bust-cache.sh
project.clj

README.md

Bild och ord

A little game designed to help young children learn to read. The idea is to familiarise the student with common words (in Swedish, as this game is implemented for a Swedish-language learning platform).

The student can drag-and-drop words to connect them with the correct illustration. In addition, typing skills are fostered by having the student type in the words as well.

Developing

The application is written in Clojure and ClojureScript and is based on the duct web application template.

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

Run go to initiate and start the system.

user=> (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. Changes to CSS or ClojureScript files will be hot-loaded into the browser.

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

If you want to access a ClojureScript REPL, make sure that the site is loaded in a browser and run:

user=> (cljs-repl)
Waiting for browser connection... Connected.
To quit, type: :cljs/quit
nil
cljs.user=>

Frontend assets

Stylesheets are written as SCSS files. To compile into CSS, run the following in a background terminal screen:

lein scss :dev auto

The sassc utility needs to be installed.

Testing

Testing is fastest through the REPL, as you avoid environment startup time.

user=> (test)
...

But you can also run tests through Leiningen.

lein test

Feature tests

These end-to-end tests in test/features use the clj-webdriver wrapper around Selenium which in turn drives PhantomJS. You'll need to have the phantomjs binary available on your path. You can get it with the node package manager. For example:

npm install -g phantomjs

Migrations

Migrations are handled by ragtime []. Migration files are stored in the resources/migrations directory, and are applied in alphanumeric order.

To update the database to the latest migration, open the REPL and run:

user=> (migrate)
Applying 001-base 
...

To rollback the last migration, run:

user=> (rollback)
Rolling back 001-base

Note that the system needs to be setup with (init) or (go) before migrations can be applied.

Deploying

Ansible

Prerequisites:

  • IP address in /etc/ansible/hosts: bild-ord-production ansible_host=...
  • ansible-galaxy install -r ansible/requirements.yml -p ansible/roles

Building and deploying an uberjar:

lein uberjar
ansible-playbook ansible/prod.yml --extra-vars "app_version=0.1.0-SNAPSHOT" --tags "deploy" --private-key ... --ask-sudo-pass --ask-vault-pass

Vagrant

Vagrant can be used to test deployment locally:

vagrant up

# if vagrant box is already running
vagrant provision

Contributors

  • Johannes Staffans
  • Robin Gower

License

Copyright © 2016 Johannes Staffans

This software is distributed under the MIT license.