Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/awibox/react-npm-package-template
The template that will help you quickly start developing your NPM package for React
https://github.com/awibox/react-npm-package-template
coveralls css-modules eslint jest npm-package react-component scss template travis-ci webpack
Last synced: 28 days ago
JSON representation
The template that will help you quickly start developing your NPM package for React
- Host: GitHub
- URL: https://github.com/awibox/react-npm-package-template
- Owner: awibox
- License: mit
- Created: 2020-01-24T15:28:22.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2023-03-04T05:47:44.000Z (over 1 year ago)
- Last Synced: 2024-05-29T02:00:39.433Z (5 months ago)
- Topics: coveralls, css-modules, eslint, jest, npm-package, react-component, scss, template, travis-ci, webpack
- Language: JavaScript
- Homepage:
- Size: 1.85 MB
- Stars: 7
- Watchers: 3
- Forks: 1
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
[](https://www.npmjs.com/package/react-npm-package-template)
[](https://travis-ci.org/awibox/react-npm-package-template)
[](https://coveralls.io/github/awibox/react-npm-package-template?branch=master)
[](https://github.com/awibox/react-npm-package-template/blob/master/LICENSE)
[](https://www.npmjs.com/package/react-npm-package-template)
[](https://dependabot.com)
[](https://github.com/awibox/react-npm-package-template/pulls)
[](https://github.com/facebook/jest)
## Table of contents
* [How to install](#howtoinstall)
* [Initializing the package](#initializing)
* [Rename a component](#rename)
* [Build of the package](#build)
* [Publishing a package](#publish)
* [Travis CI](#travis)
* [Coveralls](#coveralls)
* [Badges in the readme](#badges)
* [Community profile](#community)
* [Contributing](#contributing)
## How to install
You can use this project like template.
To do this, you need press button "**Use this template**".
Or clone repository and go to the project folder.
```bash
git clone https://github.com/awibox/react-redux-app-boilerplate.git ProjectName
cd ProjectName
```
Then you should install required dependencies.
```bash
yarn install
```
## Initializing the package
The first step is to initialize your package. You should execute following command:
```bash
npm init
```
And fill in the required fields (package name, version, license). You can correct the other fields manually in the **package.json**.
## Rename a component
The next step is to replace the ```YourComponentName``` in the entire project with the one you need.
## Build of the package
After writing the code you need to build the package with the following command:
```bash
yarn build
```
## Publishing a package
To publish a package, run the command:
```bash
npm publish
```
If you are not logged in to npm you should run the command before publishing:
```bash
npm login
```
## Travis CI
You need to register on the [Travis CI](https://travis-ci.org/) and connect the repository.
## Coveralls
You need to register on the [Coveralls](https://coveralls.io/) and connect the repository.
## Badges in the README.md
For **badges** to work you need to change the repository name in the link and image paths.
## Community profile
Don't forget to edit files such as [CONTRIBUTING.md](/.github/CONTRIBUTING.md) and [CODE_OF_CONDUCT.md](/.github/CODE_OF_CONDUCT.md).
## Contributing
Please read through our [CONTRIBUTING.md](/.github/CONTRIBUTING.md).