DEV-500 ‒ AREA

An project

Project • Installation • Team

---

Project

Overview

The goal of this project is to discover, as a whole, the software platform that you have chosen through the creation of a business application.

To do this, you must implement a software suite that functions similar to that of IFTTT and/or Zapier.

This software suite will be broken into three parts:

• An application server to implement all the features listed below (see Features)
• A web client to use the application from your browser by querying the application server
• A mobile client to use the application from your phone by querying the application server

The purpose of the application being to interconnect services between them (Outlook, Google, OneDrive, X (formerly Twitter), etc).

AREA example (Action/REAction):

• Gmail / Microsoft OneDrive
  • Action: A received email containing an attachment
  • REAction: The attachment is stored in a directory in OneDrive
• GitHub / Microsoft Teams
  • Action: An issue is created on a Git (GitHub) repository
  • REAction: A message is sent on Microsoft Teams

Features

The application will offer the following functionalities:

• The user registers on the application in order to obtain an account
• The registered user then confirms their enrollment on the application before being able to use it (see Authentication/Identification)
• The application then asks the authenticated user to subscribe to Services
• Each service offers the following components:
  • type Action
  • type REAction
• The authenticated user composes AREA by interconnecting an Action to a REAction previously configured (see Overview)
• The application triggers AREA automatically thanks to hooks

Installation

1. Clone the project

git clone git@github.com:lypitech/area.git area

2. Go in the cloned project

cd area/

Important

Before running the project, make sure you properly set up the environment variables. More informations here.

3. Run the project

docker-compose up --build

Caution

You must have Docker installed on your machine.

Now, APK installation file can be found at route ${FRONT_URL}/client.apk.

Team

Lysandre BOURSETTE lysandre.boursette@epitech.eu	Pierre MARGUERIE pierre.marguerie@epitech.eu	Esteban BOUYAULT-YVANEZ esteban.bouyault-yvanez@epitech.eu	Timéo TREGAROT timeo.tregarot@epitech.eu	Arthur DRAHY arthur.drahy@epitech.eu