Navigo Learn - MonoRepo

This is the repo for the NavigoLearn project. It contains the following projects:

• Navigo-Frontend
• API
• Glue (in this repo)

This repository is used purely to run the app locally and to call the update hook for CI/CD.

Glue

This is the glue between the frontend and the API. It is a simple nodejs server that serves the frontend and backend via a proxy so they're on the same port.

Requirements

• Git
• NodeJS 18 (LTS) or higher
• NPM
• MariaDB 10.11 (LTS) or higher

How to run

git clone --recurse-submodules git@github.com:NavigoLearn/NavigoLearn-MonoRepo.git
cd NavigoLearn-MonoRepo
npm install
npm run dev
# and connect to http://localhost:8080 in browser

How to update

git pull
npm install
npm run dev

Update submodules

This should be done by the CI when a new commit is pushed to the submodules

git submodule update --remote