0.0.1 • Published 1 year ago

@agavi_ed/ui v0.0.1

Weekly downloads
-
License
MIT
Repository
-
Last release
1 year ago

AGAVI UI LIBRARY

This repository houses the Agavi UI library, a collection of reusable UI components for building consistent and efficient user interfaces across all Agavi ecosystem frontends.

TOOLS

  • React: A JavaScript library for web and native user interfaces.
  • TypeScript: A strongly typed superset of JavaScript.
  • Tailwind: A utility-first CSS framework.
  • Storybook: A frontend workshop for building UI components and pages in isolation.
  • Vite: A next generation frontend tooling that runs and builds your library incredibly fast.
  • Vitest: A next generation testing framework.
  • ESLint: A tool that finds and fixes problems in your code.
  • Prettier: A code formatter.
  • Husky: A pre-commit hook.
  • Github Action: A tool that deploys your Storybook to GitHub page automatically.
  • Tanstack: Powerful asynchronous state management

Features

  • Consistent Design Language: Ensures a unified user experience across all Agavi applications.

  • Reusable Components: Saves development time and reduces code duplication.

  • Accessibility Focus: Built with accessibility in mind to cater to a wider user base.

  • Easy Integration: Streamlined integration process for seamless adoption in existing projects.

  • Storybook Integration: Enables interactive development and component isolation for a smooth development workflow.

Get Started

  1. Clone this repository
  2. Install dependencies using npm i (or pnpm i if you like)

Scripts

  • dev: Starts the local Storybook server, use this to develop and preview your components.
  • test: Runs all your tests with vitest.
  • test:watch: Runs tests in watch mode.
  • test:ui: Runs tests with a UI.
  • test:coverage: Runs tests and generates a coverage report.
  • build: Builds your Storybook as a static web application.
  • build:lib: Builds your component library with Vite.
  • lint: Runs ESLint.
  • format: Formats your code with Prettier.

How to install this library:


  1. Using yarn:
yarn add @agavi_ed/ui
  1. Using npm:
npm install @agavi_ed/ui

Documentation

Comprehensive documentation for the Agavi UI library, including usage examples, component details, theming options, and Storybook integration, can be found here: TBD

Contribution

We welcome contributions to the Agavi UI library! Please refer to the contributing guidelines for details on how to submit pull requests: TBD

How to contribute on this library

Clone the repository:

https://github.com/agavi-ed/agavi-ui

cd into the repository:

cd agavi-ui

Install dependencies:

yarn install

Start the local server:

yarn run dev

License

MIT