Introduction: CMSLearn is a full-stack Course Management System implemented for the COMP3004 Object-Oriented Software Engineering Course in Ruby on Rails. As requirements part of the project spec, it leverages several design patterns which are diagrammed in the docs folder and whose working implementation exists as part of our final report and code history.
| Current status | Pre-Alpha Release: Follow updates here |
| In progress | Follow https://github.com/will-r-wang/COMP3004-CMS/projects/2 for what we're currently working on |
| Owner | This repo is primarily maintained by individual contributors |
| Help | For developer or design related questions, please send an email to william.wang@hey.com |
Here are some things you need to do in order to get started with CMSLearn:
- Follow the official Rails guide to get setup with Ruby on Rails if you have not already done so
- To check if Rails is running after these steps, run
rails --versionin your terminal
- To check if Rails is running after these steps, run
- Clone this repo and navigate to the root level with
git clone https://github.com/will-r-wang/COMP3004-CMS.git - Install all the relevant dependencies with bundler and yarn
- First
bundle installfor 💎s - Then
yarn add chartkick chart.js bootstrap jquery popper.jsfor all the 🧶 packages
- First
- Seed the database with
rake db:reseed - Run
bin/rails serverand you should be ready to go!
To run the entire test suite, run bin/rails test.
For a specific tests, run bin/rails test test/<my-test.rb>.
Most of our technical documentation is contained in our final project report and the evergreen weekly report.
CMSLearn 🛡🍁📖 is released under the MIT License.
*Note: Some of the implementations of the design patterns may not be 100% valid as per industry standard, but a conscious effort was made to implement the mandatory patterns in placed where we felt was most appropriate.