Clone or download
Latest commit 292a28f Dec 10, 2018

README.md

Lumi

Lumi is a single-page web application that allows teachers to create and share content with their students and monitor their progress. Lumi is builtfor providing blended learning-tools in environments with weak infrastructure.

Lumi

It’s built with TypeScript – a node plus express and socket.io server, React.js, Redux and Material-ui. It runs as a Docker-container on a Raspberry Pi 3 or as a Electron-Standalone App on Mac OS X, Windows and Linux.

Getting started

These instructions will get you a copy of Lumi up and running on your local machine for development and testing purposes.

Prerequisites

Make sure you have git, node, and npm installed.

Installing

$ git clone https://github.com/Lumieducation/Lumi
$ cd Lumi
$ npm install
$ npm start

Open http://localhost:8080 in your browser.

Documentation

You can find a documentation about what Lumi is and how it works on http://docs.Lumi.education

Contributing

Lumi tries to improve education wherever it is possible by providing a software that connects teachers with their students. But Lumi is in a very early development stage. Every help is appreciated and welcome. You can contribute in many ways. You can help reporting, testing, and detailing bugs, and also test and suggest new features or help write the documentation. Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Lumi has adopted the code of conduct defined by the Contributor Covenant. It can be read in full here.

Get in touch

Slack or c@Lumi.education.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

License

This project is licensed under the GNU AFFERO GENERAL PUBLIC LICENSE v3 License - see the LICENSE file for details