react-pointing-arrow

Webpack React Component Boilerplate

Yet another opinionated React component boilerplate (but with Webkit!). Please make it your own - change the license, remove the linter, or maybe even add some functionality.

Features

• Webkit-powered component development
  • Local web server (hosted at localhost:3001) + React hot reload
• Inlined style compiled from SCSS files => no external CSS files for component users
• Set up for Babel / ES6
• Easy github pages deployment with gh-pages
  • Generated github site demo

Sample README content follows

Example

import React from 'react';
import MyComponent from 'my-component';

export default React.createClass({
    render() {
        return (
            <MyComponent myName="World" />
        );
    }
});

Options

Property	Type	Default	Required	Description
myName	string	World		Name of person/thing to greet.

Contributing

After cloning the repository and running npm install inside, you can use the following commands to develop and build the project.

# Starts a webpack dev server that hosts a demo page with the component.
# It uses react-hot-loader so changes are reflected on save.
npm start

# Lints the code with eslint and my custom rules.
npm run lint

# Lints and builds the code, placing the result in the dist directory.
# This build is necessary to reflect changes if you're 
#  `npm link`-ed to this repository from another local project.
npm run build

Pull requests are welcome!

License

The Unlicense