Epitech-Nantes-Tek3/AREA

AREA

---

Table of Contents

• AREA
  • Table of Contents
  • Subject Description
  • Build the Project
  • Graph of technical environment
  • Launch Services
  • Stop services
  • Free space
  • Launch Tests
  • Thanks for reading
  • Authors

Subject Description

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
• 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.

Build the Project

To build the project, you may run the command :

docker-compose build

Also, do not forget to start the docker service with

systemctl start docker

Graph of technical environment

graph LR
A[Application] --> C[Server]
B[Website] --> C[Server]
C --> D((Firebase))
D --> E((RealTime Database))
D --> F((Authentication))

Loading

Launch Services

To launch our services (described below), you may run the command :

docker-compose up -d

You can also run the following command to build and launch our services:

docker-compose up --build -d

Our Services :

• The server service will be launched on port 8080
• The client_web service will be launched on port 8081
• The client_mobile will build the mobile client of the project

The http://localhost:8081/client.apk root should provide an APK, an Android version of the mobile client.

The http://localhost:8080/about.json root should answer with the server service.

Stop services

To stop our services, you may run the command:

docker-compose down -v

Free space

To free space on your computer after havng runned our project, you can do

docker system prune

BE CAREFUL This will remove everything related to docker on your machine !

Launch Tests

Please read the following ReadMe, it contains every explanations you will need.

Thanks for reading

Feel free to read the CONTRIBUTING.md.

Do not hesitate to contact any member for any questions or remarks. You can click on each following name.

You can also find code documentation here.

Authors

Thomas Prud'homme	Nathan Rousseau	Johan Chrillesen	Tom Sarrazin	Cédric Corge