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

francoisbaudouin/LaZone

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

AREA aka LaZone

Epitech Tek3 Project

The project Area, it based on IFTTT service.

A web and mobile service, which can create action and reaction from different services

Have more information: https://alluring-bayberry-f8d.notion.site/LaZone-dff705753e1045cca387ecfd20736632

PROJECT INITIALISATION

At the root of your repository, you need to create "db_password.txt" and "db_root_password.txt" that contain your password(Don't share it):

db_password.txt:

PUT YOUR PASSWORD HERE

db_root_password.txt

PUT YOUR PASSWORD HERE

PREREQUISITE

BUILD PROJECT

docker-compose up --build

API

USER
  • get("/users/") -> get all users

  • get("/users/:id") -> get user by id

AREAS
  • get("/") -> get all areas

  • get("/:id") -> get area by id

  • delete(':/id') -> delete area by id

  • get("/enabled") -> get all enabled areas

  • get("/:id/user") -> get the user related to the specified area

ACTIONS
  • get("/") -> get all actions

  • get("/:id") -> get action by id

  • get("/areas") -> get all areas that have actions

  • get(":id/areas") -> get all areas that have specified action

  • get(":id/relatedService") -> get the related service of the specified action

REACTIONS
  • get("/") -> get all reaction

  • get("/:id") -> get reaction by id

  • get("/areas") -> get all areas that have reaction

  • get(":id/areas") -> get all areas that have specified reaction

  • get(":id/relatedService") -> get the related service of the specified reaction

SERVICES
  • get("/") -> get all services

  • get("/:name") -> get service by name

  • get("/:name/actions") -> get all actions of specified service

  • get("/:name/reactions") -> get all reactions of specified service

  • get("/parameters") -> get parameters of action/reaction linked to a service

Overall, the API provides a comprehensive set of endpoints to retrieve information about the various entities in the AREA project.