https://github.com/inseefrlab/mapex
Mobile application for interviewer work organisation
https://github.com/inseefrlab/mapex
transverse-component
Last synced: 12 months ago
JSON representation
Mobile application for interviewer work organisation
- Host: GitHub
- URL: https://github.com/inseefrlab/mapex
- Owner: InseeFrLab
- License: mit
- Created: 2021-03-31T15:35:26.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2023-12-15T08:18:25.000Z (over 2 years ago)
- Last Synced: 2025-03-27T19:40:37.444Z (about 1 year ago)
- Topics: transverse-component
- Language: JavaScript
- Size: 5.27 MB
- Stars: 1
- Watchers: 7
- Forks: 4
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Mapex
[](https://opensource.org/licenses/MIT)
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](https://reactjs.org/). It was initialized with a custom template of Create React App : [PWA Template](https://www.npmjs.com/package/cra-template-pwa) and is designed thanks to [Material UI](https://material-ui.com/).
[Storybook](https://inseefrlab.github.io/Mapex/) is available online.
# Getting started
Clone this project and navigate to the `mapex` directory
```bash
git clone git@github.com:ddecrulle/Mapex.git
cd mapex
```
You can then install dependencies using either Yarn or NPM
```bash
yarn
or
npm install
```
## Environment values
The projet contains 2 environment values. The first is the url of the back-end : [Pearl](https://github.com/InseeFr/Pearl-Jam-Back-Office)
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
```bash
yarn start
```
Project will be served locally at http://localhost:3000.
### Test
To run unit tests with jest
```bash
yarn test
```
### Build
To build the app
```bash
yarn build
```
### Storybook
To run the storybook locally
```bash
yarn storybook
```
### Things to follow for future integration
[Error Boundary](https://reactjs.org/docs/error-boundaries.html)
[Suspense for Data Fetching](https://reactjs.org/docs/concurrent-mode-suspense.html)