This is an electoral consultation project that leverages the latest web technologies to create a modern and efficient user experience.
Before you can start working with this project, you need to have Yarn installed on your system.
Yarn is a package manager for JavaScript and Node.js projects. To install Yarn, follow these steps:
-
For Windows: Visit the Yarn installation page and download the installer for Windows. Run the installer and follow the installation instructions.
npm install -g yarn yarn --version
To get started with this project, you should first clone it and install the necessary dependencies.
git clone https://github.com/DANIELSSF/Electoral-Consultation.git
cd Electoral-Consultation
yarn
Available Scripts In the project directory, you can run the following scripts:
- Starts the application in development mode. Open http://localhost:5173 in your browser to see it. The page will automatically reload if you make code changes and start json-server to simulate a database in other terminal.
yarn json-server --watch ./src/db/db.json
yarn dev
- Compiles the application for production into the dist folder. This optimizes and minifies the code for optimal performance.
yarn build
- React: A JavaScript library for building user interfaces.
- Redux Toolkit: A library for efficiently managing application state.
- Material-UI: A set of UI components for React.
- Vite: A fast development environment with hot module replacement.
- TypeScript: A superset of JavaScript that provides static typing.
If you wish to contribute to this project, please make sure to follow the contribution guidelines. You can find more information in the CONTRIBUTING.md file.
This project is licensed under the MIT License. See the LICENSE.md file for more details.
This README.md file was automatically generated based on information from the package.json file. Make sure to keep it updated as the project evolves.