https://github.com/iamrishupatel/artemis-ui

a react components library build with StoryBook, Typescript and SASS primarily for e-commerce applications
https://github.com/iamrishupatel/artemis-ui

javascript react react-component-library storybook typescript

Last synced: 3 months ago
JSON representation

a react components library build with StoryBook, Typescript and SASS primarily for e-commerce applications

• Host: GitHub
• URL: https://github.com/iamrishupatel/artemis-ui
• Owner: iamrishupatel
• Created: 2022-01-03T00:03:58.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2022-08-15T12:14:06.000Z (over 2 years ago)
• Last Synced: 2024-10-10T19:32:03.732Z (3 months ago)
• Topics: javascript, react, react-component-library, storybook, typescript
• Language: TypeScript
• Homepage: https://artemis.rlabs.dev
• Size: 351 KB
• Stars: 7
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: readme.md

Awesome Lists containing this project

README

        
# Artemis UI

## About

Artemis UI is a react components library build with [StoryBook](https://storybook.js.org), [Typescript](https://www.typescriptlang.org) and [SASS](https://sass-lang.com) primarily for e-commerce applications.

Docs and Demo can be found [here](https://artemisui.netlify.app/?path=/docs)

## How to use this library

### Installation

```

npm i artemis-ui

```

### Import the styles for components

```

import "artemis-ui/dist/index.css"

```

## Components to add in the future

- Alert

- Avatar Group

- Cards

- Multi Select

- Pagination

- Search

- Slider

- & more....

> I started learning Typescript and Storybook while making this project,

> and as I'll learn more, I'll try to update this library and make it better.

## Available Scripts

- Make sure you have [NodeJS](https://nodejs.org) and [npm](https://www.npmjs.com) installed.

In the project directory, you can run:

`npm install`

Install all the required node packages

`npm run storybook`

Starts a local development server\

This page will reload when you make changes.

`npm run build-sorybook`

Builds the storybook ready for production in to the `storybook-static` folder.

`npm run build`

Builds the library ready to publish on [npm](https://www.npmjs.com/)

> This is just a side project