Skip to content

Latest commit

 

History

History
87 lines (57 loc) · 2.39 KB

README.MD

File metadata and controls

87 lines (57 loc) · 2.39 KB

GitHub issues GitHub stars Contributions welcome code style: prettier GitHub licence

Examples made with ❤︎ by Datisekai
Created by Datisekai

Boilerplate SDK React

Boilerplate SDK React is a starter source code designed to help developers easily create npm libraries based on React. With this boilerplate, you can quickly start building your own library without the need for initial setup or building the infrastructure from scratch.

Getting started

Installing

Select a folder, navigate to it, and clone this repository with this command-line:

git clone https://github.com/datisekai/boilerplate-sdk-react.git <your_project_name>

Install dependencies

Check the package.json for the correct scripts to start projects. For example you can install dependencies:

npm install

To run the "example" source code to see the change:

  cd example
  npm install

Write components

To write components, you just need to write react code as usual at index.tsx

Publish npm

To publish to npm, you need to register for an npm account here NPM

Build the library:

npm run build

Update the project name and version in the package.json file.

  • Project Name: is the library name.
  • Version: is version at npm. Each time you publish, you must increase the version by 1, for example: 1.0.0 -> 1.0.1.

Login to your npm account:

npm login

Publish the library to npm:

npm publish

Start building your reliable and user-friendly React libraries using the Boilerplate SDK React today!

Note: Make sure you have a valid npm account and access to publish packages.

If you need any further assistance or have additional questions, please let me know.