AREA

This is the repository of the area project.

How to use

Install

You need to install ngrok and run it to create a proxy that expose your local server on the internet. You need to copy the .env.example file to a .env file and modify the variables as you need (see this file for information on how to fill environment values). The API_URL value should be the url given by ngrok. The REACT_APP_API_URL value should be the same as API_URL.

Run

dev mode:

// run ngrok
cp .env.example .env
// update .env
npm run install
npm run dev

prod mode:

// run ngrok
cp .env.example .env
// update .env
npm start

Information

You can have more information on the development process by going into the docs folder.

The project is organised as follow:

The API and Worker uses the server folder to be build.

The WEB front uses the web folder to be build.

The Mobile front uses the mobile folder to be build.

Example

You can find a live version of this project on https://area.b12powered.com.

Authors

• Brian Guitteny
• Julian Frabel
• Jules Bulteau
• Romain Fouyer
• Charlie Jeanneau
• Lilian Arago