https://github.com/fritz-c/react-pointing-arrow

https://github.com/fritz-c/react-pointing-arrow

Last synced: 27 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/fritz-c/react-pointing-arrow
• Owner: fritz-c
• License: unlicense
• Created: 2016-09-06T07:14:01.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2016-09-06T07:26:59.000Z (about 8 years ago)
• Last Synced: 2024-04-24T01:02:22.380Z (7 months ago)
• Language: JavaScript
• Homepage: https://fritz-c.github.io/react-pointing-arrow
• Size: 490 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# 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](https://fritz-c.github.io/react-pointing-arrow/)

-------------------------------------------------------------------

_Sample README content follows_

## Example

```jsx

import React from 'react';

import MyComponent from 'my-component';

export default React.createClass({

    render() {

        return (

            

        );

    }

});

```

## 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.

```sh

# 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](https://unlicense.org/)