Skip to content

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).


Before you begin, make sure you have the following installed on your system:

Getting Started

Follow these steps to get your development environment ready:

  1. 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:


    Replace with the actual URL of your API server.

  2. Install dependencies:

    Open a terminal or command prompt in your project directory and run the following command:

    npm install
    # or
    yarn install

    This will install all the necessary dependencies for the project.

  3. Start the development server:

    Run the following command to start the development server:

    npm 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.