This project aims to develop a Open-Source platform for E-Learning in computer science. We want to have an API, so Apps and other "Frontends" can be added easily.

This project is mainly developed by master-students of the University of Applied Science in Darmstadt, Germany. If you want to support this project, just say hello on Gitter.

To use Vagrant for the development download VirtualBox, install it and then do the same with vagrant. After that open the e.g. git bash AS ADMIN and go to the project root. Now run vagrant up.

After everything is installed and all npm dependencies are downloaded you can connect to the VirtualBox via vagrant ssh. The Ports 4200 and 27017 are forwarded to your host system. Just type localhost:4200 in your browser.

To start the backend ssh into the VM with vagrant ssh and run the commands seen under Run app.

To start the frontend ssh into VM with a second shell and run the commands seen under Development server.

You need docker and docker-compose.

You can install dependencies by running the following commands from the project root.

docker-compose run --rm --no-deps api npm install
docker-compose run --rm --no-deps web-frontend npm install

After installing the dependencies you can run the application by executing:

docker-compose up

You can access the web frontend on your host machine at http://localhost:4200.

The API will be proxied to http://localhost:4200/api and MongoDB is accessible at localhost:27017.

- This content may not be up to date... we try to update it asap.

1. Open a Terminal and type following:

cd /path/to/project/api
npm install

cd /api
npm start-dev

or nodemon -L index.js to 'poll'. You can use this if you are using vagrant or docker on windows/mac.

1. Copy config/test.dist.json to config/test.json and change it accordingly.
2. To execute the tests:

cd /api
npm test

- This content may not be up to date... we try to update it asap.

Run npm install -g @angular/cli@latest to install the latest version of the angular cli globally.

1. Go to app/webFrontend/
2. Run npm install in the root folder of the app
3. Run npm start to use angular-cli serve

If you have problems with the angular-cli version try following:

1. Create a new anglular-cli projekt ng new example-app
2. Copy the folder ´/src´ from this project to the new project
3. Run ng serve

This project was generated with angular-cli version 1.0.0-beta.17.

Run ng serve for a dev server. Navigate to http://localhost:4200/. The app will automatically reload if you change any of the source files.

Run ng generate component component-name to generate a new component. You can also use ng generate directive/pipe/service/class.

Run ng build to build the project. The build artifacts will be stored in the dist/ directory. Use the -prod flag for a production build.

Run ng test to execute the unit tests via Karma.

Run ng e2e to execute the end-to-end tests via Protractor. Before running the tests make sure you are serving the app via ng serve.

To get more help on the angular-cli use ng --help or go check out the Angular-CLI README.

Please have a look at CONTRIBUTING.md