@gvempire/atheneum

atheneum

atheneum is a ui component library

Table of contents

• Quick start
• Prerequisites
• Usage
• Contact
• License

Quick start

• Clone down the repo
• Install deps with yarn
• Start development server with yarn start
• Run yarn deploy to build and serve the application

Prerequisites

Before you begin, ensure you have met the following requirements:

• You have installed the latest version of node, npm, and yarn

Usage

To use atheneum, use these scripts: (if using npm, replace yarn with npm run)

build:npm - build production version of components for npm

build-storybook - build storybook static site

storybook - start storybook dev server

test - run test suite

deploy - build and publish new version of the components to npm

Contact

If you want to contact me you can reach me here or [e-mail] or vist me at gvempire.com.

License

MIT License