F05-Mobile-dashboard

Dashboard that will be used to manage the Trena project backend (F05-Mobile-backend)

This project it's using React as framework and Typescript as main language

1. Third-party

The list of all the third party libraries used are:

• Zustand: A small, fast and scalable bearbones state-management solution using simplified flux principles.
• Material-UI: A comprehensive suite of UI tools library.
• SuperAgent: Light-weight progressive ajax API crafted for flexibility, readability, and a low learning curve
• Leaflet: Leading open-source JavaScript library for mobile-friendly interactive maps.
• React-Query: Fetching, caching, synchronizing and updating server state in React applications tool
• React-Router-DOM: Client side routing library

1.2. Services

Services used to provide features into this project:

• Cep Aberto: free webservice to query CEP in Brazil.

2. Configuration

There is a file called .env in the root folder. That file holds the global environment default values used trough the application:

VITE_REACT_APP_ENVIRONMENT=development
VITE_REACT_APP_BASE_URL=http://0.0.0.0:8000
VITE_REACT_APP_SENTRY_DNS=<SENTRY_KEY>
VITE_REACT_APP_API_KEY=<API_KEY>
VITE_ADMIN_USERNAME=<ADMIN_USERNAME>
VITE_ADMIN_PASSWORD=<ADMIN_PASSWORD>
VITE_DEV_WS02_MODE=false
VITE_PUBLIC_URL=false

3. Build

The dashboard was made to be deployed using docker. To build the docker image just go to the root of the folder where the Dockerfile.prod file is and run the command:

docker build -t f05_dashboard -f Dockerfile.prod .