Night Creek UI

A lightweight UI component library for building beautiful and acessible React components
Explore the docs »

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Roadmap
4. License

About The Project

Night Creek UI is currently under development.

The main goal is to provide a component library as a source of acessible, reusable and high-customizable React components.

(back to top)

Built With

(back to top)

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

• npm

  npm install npm@latest -g

Installation

3. On the root folder, Install NPM packages. Turbo Repo will handle all sub-packages installations for us.

   npm install

4. Run the packages builds. Turbo Repo will run all packages builds for us.

   npm run dev

(back to top)

Roadmap

The v1 stable release includes the following components:

• Text
• Heading
• Box
• Button
• TextInput
• TextArea
• Checkbox
• Avatar
• MultiStepForm
• Toast
• Tooltip

Future roadmap updates will be shared soon as we start preparing for v2!

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)