readme.md

Artemis UI

About

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

Docs and Demo can be found here

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 and npm 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

This is just a side project