Skip to content

Latest commit

 

History

History
68 lines (49 loc) · 1.5 KB

README.md

File metadata and controls

68 lines (49 loc) · 1.5 KB

CUE-Dashboard

This project is a React-based dashboard application built with TypeScript, Redux Toolkit, and MUI. It provides a modern and professional user interface for managing and visualizing data.

Features

  • Modern and responsive design using MUI (Material-UI) components.
  • State management with Redux Toolkit for efficient and predictable data flow.
  • TypeScript for improved code quality and maintainability.
  • Routing using react-router-dom for easy navigation.
  • Basic structure with header, side navigation, and footer.

Technologies Used

  • React 18
  • TypeScript
  • Redux Toolkit v2
  • MUI (Material-UI)
  • react-router-dom
  • Yarn

Getting Started

Prerequisites

  • Node.js 22 (for LTS support)
  • Yarn package manager

Installation

  1. Clone the repository: 
    git clone https://github.com/ghrcdaac/CUE-Dashboard.git
  2. Navigate to the project directory: 
    cd CUE-Dashboard
  3. Install dependencies: 
    yarn install

Running the App

  1. Start the development server: 
    yarn start
    This will open the app in your browser at http://localhost:3000.

Building for Production

  1. Create a production build: 
    yarn build
    This will generate a optimized build in the build directory.

Contributing

Contributions are welcome! Please feel free to submit issues and pull requests.

License

This project is licensed under the   MIT License.