Skip to content
This repository has been archived by the owner on May 7, 2024. It is now read-only.

sopyb/NavigoLearnAPI

NavigoLearn API

Build Status Badge
Production Build Status
Master Build Status

! 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

Getting Started

Prerequisites

Installation

  1. Clone the repo

    git clone [email protected]: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