Project Setup
This document guides you through setting up your local development environment for the project, which uses Vite, React.js, Redux, Redux Toolkit, and Material-UI (MUI).
Prerequisites
Before you begin, make sure you have the following installed on your system:
- Node.js (version 16 or later): Download and install from https://nodejs.org/en/: https://nodejs.org/en/.
- npm (Node Package Manager) or yarn (Package Manager): These come bundled with Node.js installations.
Getting Started
Follow these steps to get your development environment ready:
Create environment variables:
Create a file named
.env
in the project's root directory. This file will store sensitive information like API URLs and authentication keys. Do not commit this file to a public repository!Here's an example
.env
file:txtVITE_API_BASE_URL=https://your-api-endpoint.com
Replace
https://your-api-endpoint.com
with the actual URL of your API server.Install dependencies:
Open a terminal or command prompt in your project directory and run the following command:
bashnpm install # or yarn install
This will install all the necessary dependencies for the project.
Start the development server:
Run the following command to start the development server:
bashnpm run dev # or yarn dev
This will start the Vite development server and open the application in your default browser at
http://localhost:5173
.
Next Steps
Once you have your development environment set up, you can start exploring the codebase, customizing the platform settings, and creating and managing your resources.
Technologies Used
Here's a brief overview of the main technologies used in this project:
- Vite: A modern, lightning-fast frontend build tool.
- React.js: A popular JavaScript library for building user interfaces.
- Redux: A library for managing state in React applications.
- Redux Toolkit: A library for managing asynchronous actions in React applications.
- Material-UI (MUI): A popular library for building UI components with Material Design in React.