https://github.com/bkarthik7/uds_assignment

https://github.com/bkarthik7/uds_assignment

Last synced: about 1 month ago
JSON representation

• Host: GitHub
• URL: https://github.com/bkarthik7/uds_assignment
• Owner: BKarthik7
• Created: 2025-08-20T19:15:16.000Z (about 2 months ago)
• Default Branch: master
• Last Pushed: 2025-08-20T20:27:41.000Z (about 2 months ago)
• Last Synced: 2025-08-20T22:18:11.111Z (about 2 months ago)
• Language: TypeScript
• Homepage: https://uds-assignment-beta.vercel.app
• Size: 122 KB
• Stars: 0
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# UDS Assignment

[![Storybook](https://img.shields.io/badge/Storybook-UI%20Components-ff4785?logo=storybook)](https://68a602b9cd4dbfefc9e9e03c-yuljtwukcm.chromatic.com/)

[![Vercel](https://img.shields.io/badge/Live%20Demo-Vercel-black?logo=vercel)](https://uds-assignment-beta.vercel.app/)

## Setup Instructions

1. Install dependencies:

   ```bash

   npm install

   ```

2. Start the development server:

   ```bash

   npm run dev

   ```

3. Run Storybook:

   ```bash

   npm run storybook

   ```

4. Run tests:

   ```bash

   npm test

   ```

## Approach

- **Component-Driven Development:** The project is structured using reusable React components for input fields, data tables, and tabs, promoting modularity and maintainability.

- **State Management:** React's built-in state and props are used for managing UI state and data flow between components.

- **Styling:** CSS is organized per component and uses CSS variables for theming, enabling easy customization and dark mode support.

- **Storybook Integration:** Storybook is used for isolated component development and documentation, making it easy to visualize and test UI components.

- **Testing:** Jest and React Testing Library are used for unit and integration tests, ensuring component reliability.

- **Data Handling:** User data is managed in a separate module for easy updates and scalability.

- **Accessibility:** Basic accessibility practices are followed, and Storybook's a11y addon is included for accessibility checks.

- **Extensibility:** The architecture allows for easy addition of new features or components.

This approach ensures the project is scalable, maintainable, and developer-friendly.