Mapex

Mapex for "Mon Assistant Personnalisé cross plateforme" (My Personalized Assistant cross platform) is a Progressive Web Application (PWA) for interviewer work organisation.

Mapex is built with React. It was initialized with a custom template of Create React App : PWA Template and is designed thanks to Material UI.

Storybook is available online.

Getting started

Clone this project and navigate to the mapex directory

git clone git@github.com:ddecrulle/Mapex.git
cd mapex

You can then install dependencies using either Yarn or NPM

yarn

or

npm install

Environment values

The projet contains 2 environment values. The first is the url of the back-end : Pearl

The second is a Google API Key. We use Google Geolocation API to get the latitude and longitude with the adress.

In development mode, you can create a file .env.development.local and add values like in the .env file.

Scripts

Development

To run the project locally

yarn start

Project will be served locally at http://localhost:3000.

Test

To run unit tests with jest

yarn test

Build

To build the app

yarn build

Storybook

To run the storybook locally

yarn storybook

Things to follow for future integration

Error Boundary Suspense for Data Fetching