moritzs / tutor Goto Github PK

View Code? Open in Web Editor NEW

This project forked from harald-lang/tutor

Tool used to manage tutors, groups, scores and exams for big database systems classes as TUM.

License: GNU Affero General Public License v3.0

Dockerfile 0.68% Shell 0.56% Ruby 65.64% CoffeeScript 4.09% JavaScript 0.40% CSS 1.47% HTML 27.16%

tutor's Introduction

Tutor Tool

Run with docker

Start the container, then login using [email protected] / admin123

docker run  -v /opt/tutor:/src/persistency \
            -p 8080:8080 \
            -d \
            --name tutor \
            -e GMAIL_USERNAME='[email protected]' \
            -e GMAIL_PASSWORD='XXX' \
            -e ADMIN_EMAIL='[email protected]' \
            -e SERVER_NAME='tutor.example.com' \
            kordianbruck/tutor

Environment Variables:

SECRET_KEY_BASE - (optional) will be generated on container start. at least 30 characters and all random,
EMAIL_SENDER - (optional) Default: [email protected]
EMAIL_SENDER_FULL - (optional) Default: Tutor Tool <[email protected]>
GMAIL_USERNAME - Username for email sending via SMTP
GMAIL_PASSWORD - Password for email sending via SMTP
ADMIN_EMAIL - Admin email to receive errors
SERVER_NAME - server name for the email links to be generated

Developer Setup

git clone this repo
install ruby tools: gem install rdoc && gem install bundler && gem install rake && gem install rails
run bundle install --path vendor/bundle to install any backend dependencies
run yarn for frontend deps - (You'll need nodejs+yarn+bower for this)
create your db: rake db:migrate RAILS_ENV=development
run tests bundle exec rake
run the bundled webserver: bin/rails server