https://github.com/aurbano/react-component-starter
Starter kit to release React components
https://github.com/aurbano/react-component-starter
component react react-component reactjs starter-kit
Last synced: 2 months ago
JSON representation
Starter kit to release React components
- Host: GitHub
- URL: https://github.com/aurbano/react-component-starter
- Owner: aurbano
- License: mit
- Created: 2017-07-13T09:40:58.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2017-07-13T12:56:25.000Z (about 8 years ago)
- Last Synced: 2025-06-16T05:53:21.927Z (4 months ago)
- Topics: component, react, react-component, reactjs, starter-kit
- Language: CSS
- Homepage: https://aurbano.github.io/react-component-starter/
- Size: 764 KB
- Stars: 3
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# React-Component-Starter
> Starter project for released React components
[](https://travis-ci.org/aurbano/react-component-starter)
[](https://www.npmjs.com/package/react-cs)
[](https://coveralls.io/github/aurbano/react-component-starter?branch=master)
[](https://www.npmjs.com/package/react-cs)
[](https://www.npmjs.com/package/react-cs)
[](https://www.codacy.com/app/aurbano/react-component-starter)
This is a template for releasing React components. It contains configuration for testing, building, and setting up an example page.
## Getting started
Download this repository into yours, and replace all mentions of `react-component-starter` and `react-cs` with the name of your npm package.
Install `linklocal` - this allows you to work on the example using the local version of your package as a symlink:
```console
$ npm i -g linklocal
```
Place your component source files in `src/`, and make sure that the main component file is called `index.js`.
## Testing
Tests can be added as necessary to the `test/` directory, there is an example one provided already.
Everything is configured already to send coverage reports to `codacy` and `coveralls`, so all you need is to go to their website and add the repository.
For codacy you'll need to add the `CODACY_PROJECT_TOKEN` env variable to your `.travis.yml` file:
```console
$ travis encrypt CODACY_PROJECT_TOKEN={token here} --add
```
## Building
All the build steps have been set into the following:
```console
$ npm run build
```
This will run the source through Babel, remove flow types (and generate the appropriate `.flow.js` files) and place everything in the `dist` folder. It will also minify your `index.js` file for disting.
If you have multiple files you want minified you'll have to change the `build:minify` script in your `package.json` file.
## Example page
One of the biggest time saving features (for me at least) is a pre-configured example page. Just place anything you want in `example/app` and it will be built using `create-react-app`.
To deploy that to `gh-pages` simply run `npm run deploy` (this will build your example app first as well).