https://github.com/jfusco/react-library-boilerplate
React + Webpack based boilerplate for producing React components
https://github.com/jfusco/react-library-boilerplate
boilerplate react react-library webpack
Last synced: 2 months ago
JSON representation
React + Webpack based boilerplate for producing React components
- Host: GitHub
- URL: https://github.com/jfusco/react-library-boilerplate
- Owner: JFusco
- License: mit
- Created: 2016-10-10T15:38:10.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2017-03-04T12:02:50.000Z (over 9 years ago)
- Last Synced: 2025-06-27T11:47:19.338Z (about 1 year ago)
- Topics: boilerplate, react, react-library, webpack
- Language: JavaScript
- Homepage: https://jfusco.github.io/react-library-boilerplate
- Size: 290 KB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# react-library-boilerplate
[![Build Status][build-image]][build-url]
[![peerDependency Status][peer-dep-image]][peer-dep-url]
[![devDependency Status][dev-dep-image]][dev-dep-url]
[![MIT][mit-image]][mit-url]
![npm][npm-version-image]
> Starter project for creating libraries
## Demo ##
https://jfusco.github.io/react-library-boilerplate
## Getting Started ##
#### Installation
From the root of your project.
```sh
npm install library --save
```
## Usage
Implementation of component. See [available options](#options) below.
```js
import React, { Component } from 'react';
import { render } from 'react-dom';
render(, document.getElementById('application'));
```
#### Options
* **[`foo`](#foo)**
##### foo ~ required
The `foo` of the component - used for setting up foo
```js
```
## Styling
#### Installation
Import the main SCSS file in to your application SCSS files
```scss
@import "node_modules/component/src/component/scss/styles.scss";
```
There are a few variables set to `!default` that can be overriden. If you need to change it more just override the actual styles.
**Any overriden variables needs to go above the `@import` statement to take effect**
```scss
//-- Global UI
$component-width
```
If you don't care to override variables and just want to override actual styles you may choose to import the minified compiled version of the css instead
```scss
@import "node_modules/component/dist/styles.css";
```
## Tests ##
```
npm test
```
[build-image]: https://travis-ci.org/JFusco/react-library-boilerplate.svg?branch=master
[build-url]: https://travis-ci.org/JFusco/react-library-boilerplate
[mit-image]: https://img.shields.io/npm/l/react-library-boilerplate.svg?style=flat-square
[mit-url]: https://github.com/JFusco/react-library-boilerplate/blob/master/LICENSE
[npm-version-image]: https://img.shields.io/npm/v/npm.svg?maxAge=2592000
[dev-dep-image]: https://david-dm.org/JFusco/react-library-boilerplate/dev-status.svg
[dev-dep-url]: https://david-dm.org/JFusco/react-library-boilerplate?type=dev
[peer-dep-image]: https://david-dm.org/JFusco/react-library-boilerplate/peer-status.svg
[peer-dep-url]: https://david-dm.org/JFusco/react-library-boilerplate?type=peer