diff --git a/README.md b/README.md index 9cd15f3..801a2f3 100644 --- a/README.md +++ b/README.md @@ -1,45 +1,52 @@ -epiph +epiph ====== epiph is a webapp to facilitate psychological trials based on questionnaires. -You can enter your own questionnaires with multiple question/answer types (multiple-choice (single/multi selection), text, date, etc.). Design your study and schedule visits by defining which questionnaires have to be filled out in which visit. After creating patients, you are ready to fill out questionnaires. Epiph supports exporting the gathered answers as a csv or save it to a (MongoDB) collection for direct access from multiple statistic tools (ex. R). +You can enter your own questionnaires with multiple question/answer types +(multiple-choice (single/multi selection), text, date, etc.). +Design your study and schedule visits by defining which questionnaires +have to be filled out in which visit. After creating patients, +you are ready to fill out questionnaires. Epiph supports exporting the +gathered answers as a csv or save it to a (MongoDB) collection for direct +access from multiple statistic tools (ex. R). ## Usage ### Development / run locally -This webapp is based on [Meteor](http://meteor.com). If you haven't installed it already, this is how you get it. + +This webapp is based on [Meteor](http://meteor.com). +If you haven't installed it already, this is how you get it. + ``` curl https://install.meteor.com/ | sh ``` Once meteor is installed, this command checks out the repo and starts the app. + ``` -git clone git@github.com:TeamEpiph/epiph.git -cd epiph-meteor/app +git clone https://github.com/TeamEpiph/epiph.git +cd epiph/app meteor ``` + The app now runs with an empty database on http://localhost:3000 ### Deployment -For deployment to production environments this app comes with a sample Dockerfile (app/Dockerfile_stage_kjpk). -To build a docker image you normally do something along the following lines. -``` -cd epiph-meteor/app -sudo docker build -t epiph-meteor -f Dockerfile_stage_kjpk . -sudo docker tag epiph-meteor your.registry.org/epiph-meteor:0.0.11 -sudo docker push your.registry.org/epiph-meteor:0.0.11 -``` -### Default User for login to epiph - -email: admin@admin.com -username: admin +This app can be easily deployed using docker-compose -password: password +``` +git clone https://github.com/TeamEpiph/epiph.git +cd epiph/app +docker-compose up +``` -## TODOs -Project planning is done via trello: https://trello.com/epiph +### Default User for login to epiph +* email: admin@admin.com +* username: admin +* password: password -# Copyright and license -Code and documentation copyright 2016 Patrick Recher, Ronan Zimmermann and University of Basel. Code is licensed under GPLv3. +## Copyright and license +Code and documentation copyright 2016 Patrick Recher, Ronan Zimmermann and +University of Basel. Code is licensed under GPLv3.