ENCOMPASS is a web application designed to facilitate the process of learning from and providing feedback on student work, for both individual teachers and for collaborative and professional development purposes.
- For non-commercial uses, this application is licensed under the AGPL license.
- Any use of EnCOMPASS for commercial purposes is subject to and requires a special license to be negotiated with Mathematical Thinking.
- See EnCOMPASS license details
This application uses a combination of:
Instructions for getting started with this setup, are located Github Repo
In its current state, EnCOMPASS is tightly linked with VMT. When a user signs up with EnCOMPASS, they also receive a VMT account which has the same username (and vice versa). If a user is logged in to one app, they will also be logged in to the other app. As a result, you must also be running mt-sso and VMT for user registration and login to work properly. If you do not need signup functionality while developing, then you do not need to be running VMT. If you are having a 500 or 401 error trying to log into EnCoMPASS, you may have to start up MTSSO, VMT, and ENC by running the script npm run dev-all to be able to log in properly.
If you wish to run EnCOMPASS separately, then you just need to remove the existing auth routes (server/datasource/api/auth) and middleware (server/datasource/middleware) and put in your own system. In addition, you may want to remove the components used for importing VMT work and strip out the workspace features/logic that are specific to viewing VMT replays within EnCOMPASS.
- Fork this repo (instructions)
- Install node version 8+
- Install MongoDB version 3.4.10
- Run
mongodin terminal to start the mongo daemon
npm install -g:
gruntgrunt-clichai
npm installfor the rest of the dependencies- Setting up .env file
- follow instructions from the .env.example file to create a new .env file
- edit values as given to you from cohort.
- From root directory run
grunt
- Visit app at http://localhost:8080
We are using Github for issues http://github.com/mathematicalthinking/encompass/issues
The wiki is also a good place to look for notes on the project http://github.com/mathematicalthinking/encompass/wiki
git checkout mastergit pull --rebase upstream mastergit push origin mastergit checkout -b feature-branchgit add/git commit(on feature branch)- To close an issue, add 'closed #[github issue number]' to commit message
git pull --rebase upstream master(on feature branch)git push origin feature-branch- Submit pull request (your feature branch to upstream master)
- Go to Step 5 in Git Rebase flow.
git checkout mastergit pull --rebase upstream mastergit push origin master
git checkout mastergit branch -d feature-branch
git remote -vto see remote originsgit remote add upstream https://github.com/mathematicalthinking/encompass.git- if existing upstream
git remote rm upstream
We use Prettier Add the VS code extension and configure it to format on save.
Please visit our design documentation for styling information.