NavigoLearn API

Build Status	Badge
Production
Master

! This is a work in progress !

! Expect breaking changes !

Especially database related stuff

and the api itself...

About

REST api for NavigoLearning. This project is built with Node.js, Express, and MariaDB.

Documentation

• API endpoint reference
• Internal documentation
• Contributing guidelines
• Code of conduct

Getting Started

Prerequisites

• Node.js - v18 or higher
• MariaDB - v10.11 or higher
• Git - v2.32 or higher

Installation

1. Clone the repo

   git clone git@github.com:NavigoLearn/API.git

2. Install NPM packages

   npm install

3. Create a MariaDB database

   CREATE DATABASE navigo_learn;
      USE navigo_learn;
   CREATE USER 'navigo_learn'@'localhost' IDENTIFIED BY 'password';
    GRANT ALL PRIVILEGES ON navigo_learn.* TO 'navigo_learn'@'localhost';

4. Rename the env.example folder to env and fill in the values for development.env

5. Run tests to make sure everything works

   npm test

6. Run the server

   npm run dev