Skip to content
This repository has been archived by the owner on Dec 20, 2023. It is now read-only.

Synthesis is a website for academic institutions and their students. Students, teachers and academic management can interact on this application.

License

Notifications You must be signed in to change notification settings

EmpireDemocratiqueDuPoulpe/synthesis-API

Repository files navigation

Synthesis - API

Documentation

Français

Cette API sert de serveur et de lien BDD/site pour Synthesis.

Installation L'API est simplement un serveur Express. Pour l'utiliser simplement, une interface web a été conçu et est disponible ici. Après avoir téléchargé et décompressé ce répertoire, il suffira d'exécuter npm install puis node server.js. Veuillez noter que l'API utilise une base de données PostgreSQL 12. Vous devrez alors modifier les identifiants d'accès dans config/db.js afin de connecter le serveur à votre base de données.

La documentation regroupe toutes les informations du fonctionnement de l'API ainsi qu'une interface Swagger permettant de réaliser des tests sur toutes les routes de cette dernière.

English

This API is used as a server and a DB/site link for Synthesis.

Installation The API is simply an Express server. To use it simply, a web interface has been designed and is available here. After downloading and unzipping this directory, you just have to run npm install and then node server.js. Please note that the API uses a PostgreSQL 12 database. You will have to modify the access identifiers in config/db.js in order to connect the server to your database.

The documentation includes all the information about the API operation and a Swagger interface allowing to test all the API routes.

About

Synthesis is a website for academic institutions and their students. Students, teachers and academic management can interact on this application.

Topics

Resources

License

Stars

Watchers

Forks