Doubtfire Web

A modern, lightweight learning management system.

Table of Contents

1. Getting Started
2. Resources
3. Contributing
4. Deployment
5. 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 nodejs nodejs-legacy

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

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

Install overcommit and Ruby SASS:

$ gem install overcommit sass

If gem fails, you should read the Doubfire API README to install ruby. If you are not using rbenv, e.g., using Docker instead, you may need to prepend sudo to the above commands to have root write access.

If using rbenv, rehash to ensure each of the gems are on your PATH:

$ rbenv rehash

Comply with DSTIL best practices using DSTIL's dotfiles repo. Run the following command to install DSTIL's dotfiles.

$ curl -s https://raw.githubusercontent.com/dstil/dotfiles/master/bootstrap | bash

Restart your terminal so that you can run dstil:

$ exec $SHELL
$ which dstil
dstil: aliased to /Users/Fred/.dstil/current/sources/1/files/labcheck

Install and sign the git hooks using overcommit:

$ overcommit --install
$ dstil --sign

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

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

Deployment

To compile the front-end, ensure doubtfire-api is placed as a sibling directory to doubtfire-web, then run:

$ cd /path/to/repos
$ ls
doubtfire-api    doubtfire-web
$ cd ./doubtfire-api
$ grunt deploy

You may prefix this command with the following environment variables:

• DF_API_URL - the URL of the API (e.g., https://doubtfire.com/api). This will default to window.location.host if not set and dynamically generate a URL.
• DF_EXTERNAL_NAME - a new name that removes references to the Doubtfire name should you so want to not use such its original name (😢).

Resources

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

• Lodash
• Moment.js
• Font Awesome
• UI Router
• UI Bootstrap
• UI Select
• NVD3 Charts
• Angular X-Editable
• Angular Filters
• Angular Markdown Filter

Contributing

Refer to CONTRIBUTING.md

License

Licensed under GNU Affero General Public License (AGPL) v3