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

Click to expand

1. Clone the repo

git clone git@github.com: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

• Run the project in full mode

make start

• Run the project in web mode (only web client and server)

make start-web

• Run the project in mobile mode (only mobile client and server)

make start-mobile

• Run the project in server mode (only server)

make start-server

Usage

• Go to the web client at https://localhost:8081
• Get the mobile apk at https://localhost:8081/client.apk
• Go to the mobile client at http://localhost:8082
• Go to the rabbitmq management ui at http://localhost:15672

Documentation

Requirements

Click to expand

• Python
• sphinx
• spinx_rtd_theme
• sphinxcontrib-mermaid

sphinx, sphinx_rtd_theme and sphinxcontrib-mermaid 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

For test coverage, we use the following tools

• Jest for unit tests with React:

make test_client_web

• or with coverage

make coverage_client_web

• testify for unit tests with golang:

make test_server

• or with coverage

make coverage_server

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