A template code repo for creating typescript based react component or typescript based modules to publish over npm. Just follow few steps and you can start publishing your code on npm.
A template code for creating typescript based react component or modules. Bundled with configuration for jest, eslint, prettier, and husky pre-commit hook.
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See publish notes on how to publish the package on npm.
As you already know about JS, you better know the prerequisites, Node JS and NPM.
Let's start with the following steps.
Now click here to use this template to create a new repo for package.
Once repo is created clone it into your local machine.
Now run the following code in project directory to install dependencies.
npm run setup
Thats all you are ready to create new typescript based react component package or TS module. Just update the src/index.tsx.
Follow to step to create a build.
Once you updated the src/index.tsx and created react component or typescript module.
Then the following command in projet directory.
npm run build
Once the command output is completed you will get a dist folder with index.js and index.d.ts files.
Thats all you are ready to publish your package on npm.
can test your package in the following way.
You can import your component from dist folder in your demo/index.tsx file.
Then in demo/index.tsx you can pass specific props for the component. Now run following command in demo directory
npm run start
Following step are used to run test cases created for component or module.
As Jest framework is installed in your package.json. So add test files in ___test___ folder.
Then run command to execute test cases.
npm run test
You have tested your package and ready to publish to NPM. Follow the steps.
Once the build is created successfully & tested.
Update package.json file with your package name and version and other details.
Now run the following command in project directory to login with your npm account.
npm run login
Now run the following command to publish your package on npm.
npm run publish
See also the list of contributors who participated in this project.
FAQs
A UI component library for the SMV project
We found that smv-ui demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Axios compromise traced to social engineering, showing how attacks on maintainers can bypass controls and expose the broader software supply chain.
Security News
Node.js has paused its bug bounty program after funding ended, removing payouts for vulnerability reports but keeping its security process unchanged.
Security News
The Axios compromise shows how time-dependent dependency resolution makes exposure harder to detect and contain.