To set up this project locally, follow these steps using Yarn and Vite for a smooth development experience.
- Node.js installed on your system with version 18.x || >=20.0.0 (you can use nvm for changing the node version).
- Npm installed on your system with version >=8.0.0
- Clone the repository:
git clone <repository-url>- Navigate to the project directory:
cd <project-name>- Install the project dependencies:
yarn install- Run dev mode:
yarn devThis will start the project on a local server, typically http://localhost:5173/, and you can begin exploring the enhanced data visualization features.
List of primary dependencies:
- React
- Vite
- Material UI
- ESLint
- Prettier
- Husky
- Vitest
- Mapbox
.eslintrc.jsfor linting rulesvite.config.tsfor Vite build tool configurationtsconfig.jsonfor TypeScript configurationdocker-composeanddockerfilefor Docker configurationAppThene.tsfor css theme
We are using material ui and our configuration theme file it's in AppThene.ts
See playwright/README.md.
We are using gitmoji(OPTIONAL) with husky and commitlint. Here you have an example of the most used ones:
- 🎨 - Improving structure/format of the code.
- ⚡ - Improving performance.
- 🔥 - Removing code or files.
- 🐛 - Fixing a bug.
- 🚑 - Critical hotfix.
- ✨ - Introducing new features.
- 📝 - Adding or updating documentation.
- 🚀 - Deploying stuff.
- 💄 - Updating the UI and style files.
- 🎉 - Beginning a project.
Example of use:
:wrench: add husky and commitlint config
hotfix/: for quickly fixing critical issues,usually/: with a temporary solutionbugfix/: for fixing a bugfeature/: for adding, removing or modifying a featuretest/: for experimenting something which is not an issuewip/: for a work in progress
And add the issue id after an / followed with an explanation of the task.
Example of use:
feature/5348-create-react-app
- On advanced filter, the unit of the barchart(TimeRangeBarChart) will change (year / month / day) according to the selected date range.