anthomir / speleograph

Speleograph Backend - Eurecom - Anthony El-Mir

Download required libraries

Important! requires Node >= 14, Express >= 4 and TypeScript >= 4.

# pull project
git pull "INSERT_GIT_REPOSITORY_URL"


# Download required libraries
 
# Download Node
$ https://nodejs.org/en (download node LTS)
 
# Download Docker Desktop
$ https://www.docker.com/products/docker-desktop/
  
# Download express
$ npm install express --save
 
# Download express
$ npm install typescript --save-dev
 
# Download Tsed 
$ npm install -g @tsed/cli
 
# Download Yarn
$ npm install --global yarn

Start Project With Docker

# install dependencies
$  yarn

# build project
$  yarn build

# Start docker container (using project terminal)
docker-compose up

Once the project is up and running you can use postman to interact with the backend Apis

Documentation

https://documenter.getpostman.com/view/19206411/2s93RMWFkz#57558f97-ccef-4642-ac06-4f921358b8e2

speleograph's Issues

Problème de sécurité !

Tout le monde peut voir ce fichier avec des mots de passe et des informations personnelles.
Il faut supprimer ce fichier du repo et changer les mots de passes et clés qui ont maintenant fuitées...

https://github.com/anthomir/Speleograph/blob/main/.env