Coursemology uses Ruby on Rails as its backend app server. This guide written by the awesome people at GoRails should help you to get started on Ruby on Rails (however, be careful about the Rails version you are going to install here, and make sure your system meets its requirements).
These commands should be run with the repository root directory (one level up from where this README file is) as the working directory.
-
Download bundler to install dependencies
gem install bundler:2.5.9
-
Install ruby dependencies
bundle config set --local without 'ci:production' bundle install
-
Create and seed the database
bundle exec rake db:setup -
Initialize .env file
cp env .env
You may need to add specific API keys (such as the GOOGLE_RECAPTCHA_SITE_KEY) to the .env files for testing specific features.
-
To start the app server, run
bundle exec rails s -p 3000
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'Email reminders for items which are about to start are sent via a cronjob which should be run once an hour. See config/initializers/sidekiq.rb and 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 the ConsolidatedItemEmailJob job once an hour.