NorthNerds UI

A modern, accessible, and customizable UI component library built with React, TypeScript, and Tailwind CSS.

Features

• 🚀 Built with React 19 and TypeScript
• 🎨 Styled with Tailwind CSS
• 📦 Component-based architecture
• 📚 Storybook documentation
• 🧪 Comprehensive testing setup
• 🔍 ESLint for code quality
• ⚡ Vite for fast development and building

Getting Started

Prerequisites

• Node.js (latest LTS version recommended)
• npm or yarn

Installation

# Clone the repository
git clone https://github.com/northnerds/northnerds-ui.git

# Navigate to the project directory
cd northnerds-ui

# Install dependencies
npm install

Development

# Start the development server
npm run dev

# Run Storybook
npm run storybook

# Build the project
npm run build

# Preview the production build
npm run preview

Project Structure

northnerds-ui/
├── src/              # Source files
├── .storybook/       # Storybook configuration
├── public/           # Static assets
├── components.json   # Component configuration
└── package.json      # Project dependencies and scripts

Available Scripts

• npm run dev - Start the development server
• npm run build - Build the project for production
• npm run preview - Preview the production build
• npm run lint - Run ESLint
• npm run storybook - Start Storybook
• npm run build-storybook - Build Storybook

Tech Stack

• React 19
• TypeScript
• Tailwind CSS
• Vite
• Storybook
• Vitest
• ESLint

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

License

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