@cintakita1945/my-first-package
v0.0.1
Published
Typescript library base project
Downloads
3
Readme
React Library Base Project
This repository contains a project base for creating React libraries. The tech stack used in this project is React, Tailwind, and Storybook
Table of Contents
Installation
To install React Library Base Project in your project, you need to follow these steps:
Clone the repository:
git clone https://github.com/arubaya/react-library-base-project.git
Navigate to the project directory:
cd react-library-base-project
Install the dependencies:
npm i
Usage
To use React Library Base Project in your React application, you can import the necessary components and hooks provided by the library.
Build
For build, follow these steps to set up the project:
Clone the repository:
npm run build
Running Tests
To run the tests, use the following command:
npm run test
Storybook
React Library Base Project includes a Storybook for interactive component development and testing.
To start Storybook, run:
npm run storybook
License
MIT License
Copyright (c) 2024
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.