Skip to content

doubtfire-lms/doubtfire-web

Repository files navigation

Doubtfire Logo

Doubtfire Web

A modern, lightweight learning management system.

Table of Contents

  1. Getting Started
  2. Resources
  3. Contributing
  4. License

Getting Started

If you will be using Docker, follow the instructions there.

Before you get started, make sure you have the Doubtfire API up and running. You will need to do this before continuing.

Install Node.js either by downloading it and installing it manually, or via Homebrew on OS X:

$ brew install node

or by using apt-get on Linux:

$ curl -sL https://deb.nodesource.com/setup_5.x | sudo -E bash -
$ sudo apt-get install -y nodejs

Clone the web repository, and change to the root directory:

$ git clone https://github.com/doubtfire-lms/doubtfire-web.git
$ cd ./doubtfire-web

Set up overcommit and install hooks:

$ gem install overcommit
$ overcommit --install

If gem fails, you should read the Doubfire API README to install ruby.

Install all node dependencies using npm, as well as grunt-cli and bower globally.

$ npm install
$ npm install -g grunt-cli bower

Note: You may need to install grunt-cli globally in Linux using sudo.

Install bower dependencies from bower.json:

$ bower install

Lastly, to compile and run a watch server and web server, use grunt:

$ grunt watchsvr

You can then navigate to the Doubtfire web interface at http://localhost:8000

Resources

Doubtfire Web is an Angular application built using Bootstrap. It uses many Open Source libraries, which you can read up on:

Contributing

Refer to CONTRIBUTING.md

License

Licensed under GNU Affero General Public License (AGPL) v3