README.md

LibreLingo

a community-owned language-learning platform

» Try LibreLingo now! «

💬 Chat • 👩‍💻 Contribute! • 💵 Sponsor • 📄 Development docs • ☎️ Schedule a call about Librelingo

About LibreLingo

LibreLingo's mission is to create a modern language-learning platform that is owned by the community of its users. All software is licensed under AGPLv3, which guarantees the freedom to run, study, share, and modify the software. Course authors are encouraged to release their courses with free licenses.

If you want to know why I built LibreLingo, I recommend reading my article. If you agree with LibreLingo's mission, consider helping to build and maintain it, and please consider making a monetary contribution.

Table of Contents

1. About LibreLingo
2. Platform
   • Web app
   • librelingo-yaml-loader
   • librelingo-json-export
3. Milestones
4. Attributions
5. Articles
6. Become a contributor
7. See also

Platform

Web app
The LibreLingo web app is a lightweight, interactive web app for learning foreign languages using LibreLingo courses. Features: 🎯 practice using interactive exercises 🗓️ spaced repetition 💾 save and monitor progress 🔁 synchronise progress across multiple devices 📱 works on various devices such as phones, tablets and desktop computers Screenshots

librelingo-yaml-loader

librelingo-yaml-loader is a Python 🐍 package that lets you load LibreLingo courses to create software based on LibreLingo. To see an extensive tutorial, check out this article. Setup librelingo-yaml-loader can be installed using pip: pip install librelingo-yaml-loader Loading courses in a Python program You can use librelingo-yaml-loader to load YAML-based LibreLingo courses in your Python program. from librelingo_yaml_loader import yaml_loader course = yaml_loader.load_course("./path/to/my/course") load_course returns a Course() object

librelingo-json-export

librelingo-json-export is a Python 🐍 package that contains modules that let's you export LibreLingo courses into JSON files that will be read by the web app. This might be useful if you want to deploy YAML-based LibreLingo courses as a web app. Setup librelingo-json-export can be installed using pip: pip install librelingo-json-export Exporting courses to JSON librelingo-json-export has a command line program that can export YAML-based LibreLingo courses into the JSON format used by the web app. Usage: cli.py [OPTIONS] INPUT_PATH OUTPUT_PATH Convert a YAML course into a JSON course. Options: --dry-run / --no-dry-run --help Show this message and exit.

Milestones

Current focus
Make it possible to contribute to courses through GitHub

• 🏁 Demo course content in Spanish for English speakers
• 🏁 Some basic building blocks of course content implemented
• 🏁 Developers can use course editor
• 🏁 Basic theme/branding
• 🏁 Course progress can be properly synchronised across devices
• 🏁 Course editor can be accessed by all course contributors
• 🏁 At least the basics of the Spanish course are ready
• 🏁 Most of the course building blocks are implemented
• 🏁 All of the basic building blocks of courses are implemented
• 🏁 Spaced repetition implemented

Become a contributor

🌍 UI translation 🔗 POEditor translation project!

📖 Course content Getting started

👩🏾‍💻 Development 🌟 Getting started 📜 Development documentation

You can help LibreLingo by testing it and submitting feature requests or bug reports: https://github.com/kantord/LibreLingo/issues/new. If you want to get in touch, you can use my contact details on my GitHub profile.

Confused? Have a question?

There is a Matrix/FreeNode IRC channel #LibreLingo, instructions for joining:

• Matrix: #LibreLingo on matrix.org
• IRC: connect to irc.freenode.net with your favourite client and join #LibreLingo

Articles

• Why I built LibreLingo
• Practice TDD by creating a LibreLingo-based language-learning app

License

LibreLingo is licensed under the AGPL-3.0 License. Course content and other creative content might be licensed under other licenses, such as CC.

This image shows a summary of the licensing of our dependencies:

Attributions

Mascot

Mascot images are released under Creative Commons Attribution-ShareAlike 4.0 International License.

The mascot is designed by @almostdesigner.

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Daniel Kantor 💻	Klemen Skerbiš 🤔	Mirek Mazel 🤔	Chris Babcock 🤔	Liaizon Wakest 🤔	Trolli Schmittlauch 🤔	Jérôme Deuchnord 🤔
Felix Ableitner 🐛	Navan Chauhan 🚇 💻 🎨 📖	Roshan Jossy 🤔 💻 📖	ledgelight 🤔	Francis Tyers 🤔 📖	titanix 🤔	Michael Moroni 🌍
pssandhu 🎨	Stefan Lobbenmeier 🐛	kylepollina 💻	slesingerm 🤔 🐛 👀	iasonasma 💻 ⚠️	Caroline Delesalle 🎨	borbota 🐛
decentral1se 📖 🤔	James Adams 🐛	Arnold Schrijver 🤔	Dale Visser 🐛	oscarfrancois 📖	dhelmr 💻	Matt 👀 🐛 🚧 💻 📖
Jean-André Santoni 🤔 📖 🎨	Lucas Campos Teixeira e Nascimento 📖 🤔 🐛	Pooja Desur 📖	Wesley Mutwiri 💻	Simon B. 🤔	Karthik Shetty 🚧	Joshua Ide 💻
Jobe Dylbas 💻	Dávid Kristián Luterančík 🤔 💻	Sai Sandeep Mutyala 💻	Artur Bauer 💻	Etza 💻	Kyle Mumma 💻 🤔	zinovik 💻
Himank Pathak 💻 🐛	x4th 💻	Christian Dimas 💻	Marco Ciampa 🐛	Joshua | DC7IA 🐛	Reyzadren 🤔	Andreas 📖
Marco H 🖋	Dan OReilly 🤔	Douglas Ferlini 💻	Michael Nock 💻 🤔	davidak 🤔	adnan360 🖋 🤔 📖	Lamdarer 📖
Luther 🤔	Nart Tlisha 🐛	Binyamin Aron Green 📖	Stéphane Guillou 🤔	Mohammad-Ali A'RÂBI 🖋	RGBradley 🖋	Cameron Radmore 🖋 💻
Zeb Burke-Conte 📖 💻 🐛	Florian CUNY 🤔	uberstar100 🤔	Gabe D 🐛 💻	Ekaterina Mozheiko 💻	Gerardo Alcantara 💻

This project follows the all-contributors specification. Contributions of any kind welcome!

See also

• omnilingo, listening-based language learning