Skip to content

benasdeveloper/norabyte.ui.commons

Repository files navigation

Norabyte UI Commons

Norabyte UI Commons is a React-based library of commonly used components designed to streamline the development of modern system interfaces. Built with TypeScript and TailwindCSS, this library provides a modular, customizable, and efficient solution for creating consistent and reusable UI elements.

Features

  • 🚀 React & TypeScript: Type-safe components for a robust development experience.
  • 🎨 TailwindCSS: Easily customizable styling with utility-first CSS.
  • 📖 Storybook Integration: Document and visualize components interactively.
  • 🛠 Modern Tooling: Built with Vite for fast development and build processes.
  • Component Variants: Simplified styling with tailwind-variants.

Development

Getting Started

To run the project locally, clone the repository and install the dependencies:

git clone https://github.com/your-username/norabyte.ui.commons.git
cd norabyte.ui.commons
npm install

Scripts

  • npm run dev: Starts the development server with Vite.
  • npm run build: Builds the library for production.
  • npm run lint: Lints the codebase using ESLint.
  • npm run preview: Previews the production build.
  • npm run storybook: Starts the Storybook server for interactive component development.
  • npm run build-storybook: Builds the Storybook documentation.

Project Structure

src/
├── components/    # Reusable UI components
│   └── Text/      # Example Text component with variants
├── styles/        # Global styles (TailwindCSS)
├── App.tsx        # Example application entry point
├── main.tsx       # React entry point

Technologies

  • React: A library for building user interfaces.
  • TypeScript: Type-safe JavaScript.
  • TailwindCSS: Utility-first CSS framework.
  • Storybook: Component documentation and development.
  • Vite: Modern frontend tooling for fast builds.

Author

Created by Bene-Hur Pessoa.

License

This project is licensed under the MIT License.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published