Inument Task - Simple Dashboard

Introduction

Welcome to the Inument Task - Simple Dashboard project! This README.md file provides essential information about the project, its purpose, technology stack, and how to get started.

Table of Contents

• Project Overview
• Technology Stack
• Getting Started
  • Cloning the Repository
  • Running the Project
• What You Will Find Inside the Project
• Project Functionality
• License

Project Overview

The Inument Task - Simple Dashboard is a web application built using React with Vite as the development tool. This project serves as a simple dashboard, showcasing a few users and providing dynamic sidebar navigation. You can collapse the sidebar by clicking on the sidebar logo and access additional functionality.

Technology Stack

• React: A popular JavaScript library for building user interfaces.
• Vite: A fast development build tool that supports modern web technologies.

Getting Started

Follow the steps below to get this project up and running on your local machine.

Cloning the Repository

You can clone the project using either SSH or HTTPS. Choose one of the following options:

• SSH (Secure Shell):

  git clone git@github.com:devhabib/inument.git

• HTTPS:

  git clone https://github.com/devhabib/inument.git

Running the Project

1. After cloning the repository, navigate to the project directory:

   cd inument

2. Install the project dependencies using npm or yarn:

   npm install
   # or
   yarn install

3. Start the development server:

   npm run dev
   # or
   yarn dev

4. Open your web browser and visit http://localhost:5173/ to access the Simple Dashboard.

What You Will Find Inside the Project

Inside the project, you will find the following features:

• Collapsible Sidebar: Click on the Sidebar logo to collapse the sidebar. There is also an additional collapse button.
• Simple Dashboard: The dashboard displays a list of users.
• Dynamic Sidebar Menu: The sidebar menu is generated dynamically.
• Active Link Feature: The sidebar menu highlights the active link.
• Add User Modal: Clicking on the "Add User" button opens a modal for adding users. Full name and email validation is implemented.

License

This project is licensed under the MIT License - see the LICENSE file for details.