Coursemology is an open source gamified learning platform that enables educators to increase student engagement and make learning fun.

1. Ruby (= 3.3.5)
2. Ruby on Rails (= 7.2.2.1)
3. PostgreSQL (= 16) with PGVector extension
4. ImageMagick or GraphicsMagick (For MiniMagick - if PDF processing doesn't work for the import of scribing questions, download Ghostscript)
5. Node.js (v22 LTS)
6. Yarn
7. Docker (installed and running)
8. Redis

We use Git submodules. Run the following command to initialize them before proceeding:

$ git submodule update --init --recursive

Coursemology consists of three main components:

1. Keycloak authentication provider
2. Ruby on Rails application server
3. React frontend client

Set up and run each component sequentially by following the linked documentation pages. As you proceed, open a new terminal window for each component after the previous component has been fully set up and started running.

Once each component has been set up and is running on their own terminals, you can access the app by visiting https://localhost:8080, and log in using the default user email and password:

email: test@example.org password: Coursemology!

Create an issue on the Github issue tracker or come talk to us over at our Slack channels.

We welcome contributions to Coursemology! Check out the issue tracker and pick something you'll like to work on. Please read our Contributor's Guide for guidance on our conventions.

If you are a student from NUS Computing looking for an FYP project, do check with Prof Ben Leong.

Copyright (c) 2015-2023 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.

We are actively running Coursemology and can provide free use of our infrastructure on a case by case basis. Please contact Prof Ben Leong if you would like to explore this option.

The Coursemology.org Project was made possible by a number of teaching development grants from the National University of Singapore over the years. This project is currently supported by the AI Centre for Educational Technologies.