Table of contents

• How to install
• Initializing the package
• Rename a component
• Build of the package
• Publishing a package
• Travis CI
• Coveralls
• Badges in the readme
• Community profile
• 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.

git clone https://github.com/awibox/react-redux-app-boilerplate.git ProjectName
cd ProjectName

Then you should install required dependencies.

yarn install

Initializing the package

The first step is to initialize your package. You should execute following command:

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:

yarn  build

Publishing a package

To publish a package, run the command:

npm publish

If you are not logged in to npm you should run the command before publishing:

npm login

Travis CI

You need to register on the Travis CI and connect the repository.

Coveralls

You need to register on the Coveralls 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 and CODE_OF_CONDUCT.md.

Contributing

Please read through our CONTRIBUTING.md.