Doubtfire Web

A modern, lightweight learning management system.

🛠 Migration Status: In Development

Doubtfire web migration from AngularJS/Coffeescript to Angular/Typescirpt, including refactoring all components, is currently in development.

See the progress of component migration below.

Migration Progress

SUMMARY:

18 / 225 components migrated

MIGRATED:

TODO:

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.

First, clone the web repository, and change to the root directory:

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

You can automate the installation process by running the automated setup script:

$ ./setup.sh

Or, you can continue following the below steps to manually install doubtfire-web.

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_10.x | sudo -E bash -
$ sudo apt-get install nodejs

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

Install and sign the git hooks using overcommit:

$ overcommit --install
$ overcommit --sign

Install all node dependencies using npm, as well as grunt-cli globally:

$ npm install

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

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

$ npm start

This will automatically run the angular 1 grunt watch, and the angular 7 ng serve.

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:

Contributing

Refer to CONTRIBUTING.md

License

Licensed under GNU Affero General Public License (AGPL) v3

Name		Name	Last commit message	Last commit date
Latest commit History 2,827 Commits
.git-hooks @ b8c0126		.git-hooks @ b8c0126
docs		docs
karma		karma
src		src
.dockerignore		.dockerignore
.editorconfig		.editorconfig
.gitignore		.gitignore
.gitmodules		.gitmodules
.overcommit.yml		.overcommit.yml
.ruby-version		.ruby-version
CONTRIBUTING.md		CONTRIBUTING.md
Dockerfile		Dockerfile
Gruntfile.js		Gruntfile.js
LICENSE		LICENSE
README.md		README.md
angular.json		angular.json
browserslist		browserslist
build.config.js		build.config.js
env.config.js		env.config.js
migration_progress.sh		migration_progress.sh
module.prefix		module.prefix
module.suffix		module.suffix
ngsw-config.json		ngsw-config.json
package-lock.json		package-lock.json
package.json		package.json
setup.sh		setup.sh
tsconfig.json		tsconfig.json
tslint.json		tslint.json

License

benphilip1991/doubtfire-web

Folders and files

Latest commit

History

Repository files navigation

Doubtfire Web

🛠 Migration Status: In Development

Migration Progress

Table of Contents

Getting Started

Deployment

Resources

Contributing

License

About

Resources

License

Stars

Watchers

Forks

Languages