Coursemology is an open source gamified learning platform that enables educators to increase student engagement and make learning fun.
Setting up Coursemology
- Ruby (>= 2.5.3)
- Ruby on Rails
- PostgreSQL (>= 9.5)
- ImageMagick or GraphicsMagick (For MiniMagick- if PDF processing doesn't work for the import of scribing questions, download Ghostscript)
- Node.js (<= 9.6)
We use submodules in the git repo; use this command to update submodules:
git submodule update --init --recursive
Download bundler to install dependencies
$ gem install bundler
Install ruby dependencies
$ bundle install --without ci:production
$ cd client && yarn; cd -
Create and seed the database
$ bundle exec rake db:setup
Start webpack and the development app server
$ foreman start
Or if you are not using foreman:
# Start the webpack dev server: $ cd client && yarn build:development # Run this command to compile the assets before running the test suite. $ cd client && yarn build:test
You're all set! Simply login with the default username and password:
To make sure that multi tenancy works correctly for you, change the default host in
config/application.rb before deploying:
config.x.default_host = 'your_domain.com'
Opening Reminder Emails
Email reminders for items which are about to start are sent via a cronjob which should be run
once an hour.
config/schedule.yml for sample configuration which
assumes that the Sidekiq and
Sidekiq-Cron gems are used.
If you use a different job scheduler, edit those files so your favourite job scheduler invokes
ConsolidatedItemEmailJob job once an hour.
If you are a student from NUS Computing looking for an FYP project, do check with Prof Ben Leong.
Copyright (c) 2015-2019 Coursemology.org. This software is licensed under the MIT License.
You're more than welcome to use Coursemology for your own school or organization. If you need more help, join our Slack channel to reach our core developers.
The Coursemology.org Project was made possible by a number of teaching development grants from the National University of Singapore over the years.