INSTALL.md

How to Download and Run the Project 👩🏽‍💻

Download project ⬇️

Clone https://github.com/elimu-ai/webapp.git

Run application locally 🛠️

To be able to compile and execute the web application locally, you will first need to install the following:

• Java Development Kit (JDK)

  • macOS: brew install openjdk
  • Windows: Download from https://learn.microsoft.com/en-us/java/openjdk/download

• Maven

  • macOS: brew install maven
  • Windows: Download ZIP file from https://maven.apache.org/download.cgi

Go to the project's folder:

cd webapp/

Compile the source code:

mvn compile

Then, to run the application, type:

mvn jetty:run

Next, to access the application in your browser, go to http://localhost:8080/webapp

Debug 🪲

Tip

To run the application in debug mode, replace mvn with mvnDebug in the command above ☝️

Test 🚨

Unit testing

Run all tests:

mvn clean test

Run individual tests:

mvn clean test -D test=WordDaoTest

Code coverage

mvn test
open target/site/jacoco/index.html

Test server

https://<language>.test.elimu.ai

Prod server

https://<language>.elimu.ai

Note

See instructions for deploying the webapp on a production server in src/main/config/DEPLOY.md.

Supported languages 🌐

A list of the currently supported languages is available at https://github.com/elimu-ai/model/blob/main/src/main/java/ai/elimu/model/v2/enums/Language.java

Note

The default language used during development is English (ENG). To switch to another language, edit the content.language property in src/main/resources/config.properties.

---

elimu.ai - Free open-source learning software for out-of-school children ✨🚀

Website 🌐  •  Wiki 📃  •  Projects 👩🏽‍💻  •  Milestones 🎯  •  Community 👋🏽  •  Support 💜