digitalfabrik / lunes-cms

The back end for the Lunes vocabulary trainer. Front end: https://github.com/digitalfabrik/lunes-app.
https://lunes.app
Apache License 2.0
20 stars 8 forks source link
content-management-system django python vocabulary-learning vocabulary-trainer

CircleCI Coverage Documentation Status PyPi License Code style: black Pylint

Lunes CMS

Logo Lunes - Vocabulary for your profession.

This is a Django 3 based content management system for the vocabulary trainer app Lunes, a project powered by Tür an Tür – Digitalfabrik gGmbH. The main goal is to develop an application which facilitates migrants to acquire technical and subject-specific vocabulary. For more information please see our GoVolunteer ad.

TL;DR

Prerequisites

Following packages are required before installing the project (install them with your package manager):

E.g. on Debian-based distributions, use:

cat requirements.system | xargs sudo apt-get install

Installation

git clone git@github.com:digitalfabrik/lunes-cms.git
cd lunes-cms
./tools/install.sh

Run development server

./tools/run.sh

Development documentation

For detailed instructions and the source code reference have a look at our documentation:

:notebook: https://lunes-cms.rtfd.io

API documentation

The API usage documentation is available here:

:iphone: https://lunes.tuerantuer.org/api/docs/

License

Copyright © 2020 Tür an Tür - Digitalfabrik gGmbH and individual contributors. All rights reserved.

This project is licensed under the Apache 2.0 License, see LICENSE and NOTICE.md.