AREA

AREA (Action Reaction) aims to connect multiple services together, similar to IFTTT.
With AREA, you can create automated workflows that integrate various services and perform actions based on specific triggers.

Table of Contents

• Getting Started
  • Prerequisites
  • Installation & Usage
• Documentation
  • Requirements
  • Usage
• Tests
• License
• Contributors

Getting Started

Prerequisites

• docker
• make

Installation & Usage

Click to expand

1. Clone the repo

git clone [email protected]:ASM-Studios/AREA.git

2. Create .env files

• Run the following command to create private env files

cp .env.example .env
cp server/.env.server.example server/.env.server
cp client_web/.env.local.example .env.local
cp client_mobile/.env.mobile.example .env.mobile

• Fill the .env, .env.web and .env.mobile files

4. Run the project

make start

Documentation

Requirements

Click to expand

• Python
• sphinx
• spinx_rtd_theme

sphinx and sphinx_rtd_theme can be installed using pip

Usage

The documentation is automatically built and deployed to GitHub Pages when a push is made to the main branch.

You can consult the documentation online at AREA Documentation.

You can build the documentation locally by running the following command:

cd AREA/docs
make docs

Tests

// TODO

License

This project is licensed under the terms of the GLP3.0 license. See the LICENSE file for details.

Contributors

This project was developed by:

• Maël RABOT
• Mathieu COULET
• Mathieu BOREL
• Charles MADJERI
• Samuel BRUSCHET