Giter VIP home page Giter VIP logo

react-component-starter-kit's Introduction

React Component Starter Kit

This is supposed to be a simple starter-kit for creating Open Source React Components. It should include/support:

  • a nice README
  • some kind of LICENSE
  • build + tests
  • dist files (amd, common, global)
  • .dotfiles
  • example + demo (gh-pages, maybe?)

Getting Started

Just clone or fork the repo and start hacking:

$ git clone -o your-component -b master --single-branch https://github.com/daviferreira/react-component-starter-kit.git your-component

Commands

$ cd your-component
$ npm install                   # Install development dependencies
$ npm run bundle                # Build scripts
$ npm run demo                  # Run webpack dev server

Your Component Name Here

A magic description.

NPM info

Travis build status Dependency Status devDependency Status Coverage Status

Usage

Development

Contributing

LICENSE

MIT: https://github.com/daviferreira/react-component-starter-kit/blob/master/LICENSE

react-component-starter-kit's People

Contributors

daviferreira avatar greenkeeperio-bot avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

Forkers

svkangal anvk

react-component-starter-kit's Issues

Location for test files?

I just wondering if test/ folder is the best location for the test files. In a relatively small component it is not a big deal. But for a fairly complex component with many files within the src/ folder can get very ugly. Maybe it is the best to keep test files in test/ directory.

Any thoughts ?

Adding examples for CSS or LESS or SCSS

Most often React component come with supplementary style sheet files like CSS or, even more often, SCSS or LESS which have to be transpiled into CSS. It would be awesome if you could add some basic samples in this project for anyone who is facing a similar challenge.

Update .npmignore file?

You have a great .npmignore file. I thought that it possibly could be better if you use default Node.js npmignore file provided by GitHub. I believe the content of it something like that.

# Logs
logs
*.log
npm-debug.log*

# Runtime data
pids
*.pid
*.seed

# Directory for instrumented libs generated by jscoverage/JSCover
lib-cov

# Coverage directory used by tools like istanbul
coverage

# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
.grunt

# node-waf configuration
.lock-wscript

# Compiled binary addons (http://nodejs.org/api/addons.html)
build/Release

# Dependency directory
node_modules

# Optional npm cache directory
.npm

# Optional REPL history
.node_repl_history

Adding .npmignore

First of all I wanted to say that I really like your repo. Awesome work!

I was thinking that maybe adding .npmignore would be very beneficial to the project. I do not believe you want to pull demo/ or test/ folder when you install React component.

Any thoughts on this ?

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.