Skip to content

Daniel-TheProgrammer/mini-project

Repository files navigation

React Project with Material UI and Rest Api

Getting Started

Prerequisites

Before running this project, ensure you have Node.js and npm installed on your local machine.

Installation

  1. Clone this repository to your local machine:

    git clone https://github.com/Daniel-TheProgrammer/mini-project
  2. Navigate to the project directory:

  3. Install dependencies: npm install

Running the Development Server

To run the development server and start the application locally, run the following command:npm run dev

This will start the development server and open the application in your default web browser. You can access it at http://localhost:3000.

Setting Environment Variables

This project requires the environment variables VITE_USER and VITE_PASSWORD to be set for authentication purposes. Follow the steps below to set them:

  1. Create a .env file in the root directory of the project.

  2. Add the following lines to the .env file:

VITE_USER=your-username VITE_PASSWORD=your-password

Replace your-username and your-password with your actual credentials.

Building for Production

To build the project for production, run:

This will generate a production-ready build of the application in the dist directory.

Additional Information

For more information about Vite, please refer to the official documentation.