Why does this project exist?
This project exists to create a beginner-friendly, community-oriented, free software licensed language learning application. If you want to learn more about LibreLingo's background, I recommend reading my article.
Clickable flow chart
Setting up the development environment
Clone the repository:
git clone [email protected]:kantord/LibreLingo.git
Move into the repo directory:
You will need Node. Note that this project is not yet compatible with Node v16.
yarn set version classic yarn
Start the development server:
yarn web dev
Now you should be able to see your app on http://localhost:3000/
Exporting a course from YAML
You will need Poetry.
Install dependencies at the top level and for the app:
poetry install cd apps/librelingo_yaml_loader poetry install cd ../.. cd apps/librelingo_json_export poetry install cd ../..
Export a course:
./scripts/exportYamlCourse.sh <course directory name>
Setting up Semaphore CI in a clone
In order for Semaphore CI to correctly operate, you will need to set up certain secrets.
This might not be necessary for you in all cases, but it cannot be avoided if you want to fully fork the repo, or work on CI configuration related tasks.
Here's a list of the tokens you need to set up. Each of them is a link to a page explaining how to obtain the token: