Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/geli-lms/geli
geli is an open source e-learning platform
https://github.com/geli-lms/geli
e-learning elearning
Last synced: 14 days ago
JSON representation
geli is an open source e-learning platform
- Host: GitHub
- URL: https://github.com/geli-lms/geli
- Owner: geli-lms
- License: apache-2.0
- Created: 2017-03-14T13:56:14.000Z (over 7 years ago)
- Default Branch: develop
- Last Pushed: 2022-12-22T10:36:33.000Z (almost 2 years ago)
- Last Synced: 2024-04-14T19:52:09.124Z (7 months ago)
- Topics: e-learning, elearning
- Language: TypeScript
- Homepage:
- Size: 53.2 MB
- Stars: 150
- Watchers: 20
- Forks: 70
- Open Issues: 139
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# geli -- unfortunately no active developers for now :(
[](https://github.com/geli-lms/geli/releases)
[](https://travis-ci.com/geli-lms/geli)
[](https://coveralls.io/github/geli-lms/geli?branch=develop)
[](https://stats.uptimerobot.com/mq8EDc8lx)
[](https://gitter.im/mpse-geli/Lobby)
[](https://david-dm.org/geli-lms/geli?path=api)
[](https://david-dm.org/geli-lms/geli?path=app/webFrontend)
geli is an open source e-learning platform. Try the [demo](https://demo.geli.fbi.h-da.de/)!
The project is mainly developed by Computer Science Master's students at the
[University of Applied Sciences in Darmstadt, Germany](https://www.fbi.h-da.de).
If you need help using or want to support the project, just say hello on
[Gitter](https://gitter.im/mpse-geli/Lobby).
## Usage
Your best option for running the project is by using our Docker images:
- [API](https://hub.docker.com/r/hdafbi/geli-api)
- [Web frontend](https://hub.docker.com/r/hdafbi/geli-web-frontend)
Have a look at the sample [docker-compose file](docker-compose.prod.yml) on how
to wire things together.
For a list of all configuration options see [docs/configuration](docs/configuration.md).
## Development
The codebase is written entirely in [TypeScript](https://www.typescriptlang.org/).
The API is based on [Node.js](https://nodejs.org) together with [Express](http://expressjs.com),
[routing controllers](https://github.com/pleerock/routing-controllers) and
[MongoDB](https://www.mongodb.com).
Have a look at our [API documentation](https://github.com/geli-lms/geli-docs/).
The web frontend is built with [Angular](https://angular.io/) 6 and
[Angular Material](https://material.angular.io/) components.
### Running
You have multiple options for running the project for development purposes.
- [Docker](docs/development/running-with-docker.md)
- [Locally](docs/development/running-locally.md)
After successfully starting, the web frontend will be available at
[http://localhost:4200](http://localhost:4200).
The API will be available at [http://localhost:3030](http://localhost:3030). To avoid
[CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing) the API will also be proxied by
the Angular development server and be available at
[http://localhost:4200/api](http://localhost:4200/api).
### Configuration
The default configuration should already enable you to start developing.
For more information on how to configure e.g. e-mail see
[docs/development/configuration](docs/development/configuration.md).
### Commands
#### API & web frontend
- __Running__: `npm run start`
- __Linting__: `npm run lint`
- __Testing__: `npm run test`
#### API
- __Loading fixtures__ (sample data): `npm run load:fixtures`
- __[Debugging](https://nodejs.org/en/docs/inspector/)__: `npm run start:inspect`
#### Web frontend
- __End to end tests__: `npm run e2e`
- __[Angular CLI](https://cli.angular.io/)__: `npm run ng`
(Be sure to pass flags with additional dashes. E.g.: `npm run ng build -- --prod`)
## Contributing
Please have a look at our [contributing guide](.github/CONTRIBUTING.md).
## LICENSING
Copyright [2018] [Ute Trapp]
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.