osscameroon/lewa

A platform to learn African writing systems. lewa === A platform to learn African writing systems. Background --- Africa is home to several writing systems. However, most of these systems are primarily used by linguists and are not widely adopted by the general population. Today, many Africans rely on English or French spellings to express native sounds in writing. While Input Method Engines (IMEs) exist to facilitate typing in these scripts, they assume prior knowledge of the writing system. But how can someone use an IME if they haven't learned the script? Through this project, we aim to make African writing systems more accessible by helping users learn not only the scripts themselves, but also their alphabets and pronunciations. ## Table of Contents * Installation * Contributing * Support * License ## 📖 Installation Lewa can be installed via Pip or Docker. To start, clone the repo to your local computer and change into the proper directory. ### 🧰 Prerequisites - **Python 3.11+** (Download) - **Docker** (Optional) (Install Docker) - **UV** (Optional, for fast Python package management) (Install UV) ### Install Dependencies - With Pip: ```sh pip install . ``` - With uv: ```sh uv sync ``` - With Docker: Not needed ### Setup - With Python: ```sh python lewa/manage.py migrate ``` - With uv: ```sh uv run lewa/manage.py migrate ``` - With Docker: Not needed ### Run the App - With Python: ```sh python lewa/manage.py runserver ``` - With uv: ```sh uv run lewa/manage.py runserver ``` - With Docker: ```sh docker compose up -d ``` ### Load the dummy data - With Python: ```sh python lewa/manage.py shell -c "import core.dummy_data" ``` - With uv: ```sh uv run lewa/manage.py shell -c "import core.dummy_data" ``` - With Docker: ```sh docker compose exec lewa ./entrypoint.sh shell -c \"import core.dummy_data\" ``` **Access the webapp** Open your browser at: 127.0.0.1 or 127.0.0.1 for the admin ## 🤝 Contributing Contributions, issues and feature requests …