Planet Learning is a generic learning system built in Angular & CouchDB.
To work on this
The only prerequisite is Vagrant. If you don't know about it, please do some research and try it. After cloning the repository, run
vagrant up dev in the console. Once it's done installing the virtual machine it'll automatically start compiling the app. After about 10 seconds, you can open the app at
- Please check out the project page for available tasks to work on.
- Before contributing also be sure to read our style guide
- Please clone the repository rather than forking, unless you're from outside the organization. It's easier for us to collaborate from a new branch on the same repository.
- After cloning the repository please run
npm run install-hooksto add the git hooks to your local repository.
- If you see something that needs work, please create an issue. If the issue is on the frontend, please try to make it specific to one component.
- To work on an issue, create a new branch with a descriptive title.
- Please wait for at least two positive reviews before merging a PR into the master branch
Unit & end-to-end tests
There are two ways for running the tests. The first listed works from the host machine, and the second works after
vagrant ssh dev and
npm run v-test (from host) or
ng test (from vagrant) - Unit tests
localhost:9876 once this is done compiling
npm run v-e2e (from host) or
ng e2e (from vagrant) - End-to-end tests
Results will appear in the console
Similarly, we have a few other npm commands that work from the host machine to run the
ng commands from the Angular CLI
npm run v-serve =
npm run v-build =
npm run v-lint =
npm run v-lint-fix =
ng lint --fix This will fix any lint errors that TSLint can automatically fix
npm start command can include an additional
LNG variable to serve from different language files. This must be run from within the vagrant (so after
vagrant ssh dev and
cd /vagrant) and runs in the format:
LNG=es npm start
This would serve the app from the Spanish language files.
I switched branches and now I'm missing a dependency...
The ideal solution would be to ssh into your vagrant and run npm install:
vagrant ssh dev cd /vagrant npm install
This doesn't always work. If you're having trouble or need to revert to the exact dependencies listed on the package.json, you need to remove all packages then install (after cd /vagrant above, run the commands):
sudo rm -rf node_modules/* sudo npm install --unsafe-perm
/* will remove all files & sub-directories of node_modules. You won't be able to remove node_modules because of the link between the vagrant VM and your host.
Cannot GET /
There are two things you can try for this. First involves the node-sass module which can be problematic. You will need to rebuild it from the VM:
vagrant ssh dev cd /vagrant npm rebuild node-sass
The second is to rebuild the application. First you need to cancel the app in the screen with
screen -x then CTRL-C. Then you can bring the app back up with one of the above commands or in another screen session with
screen -dmS build bash -c 'cd /vagrant; ng serve'.