Create React component with no configurations.
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
template
test
.editorconfig
.gitattributes
.gitignore
LICENSE
README.md
circle.yml
cli.js
package.json
sao.js
yarn.lock

README.md

create-react-component-with-no-config

NPM version NPM downloads CircleCI

Create React component with no configurations.

Inspired by the awesome vue-land/create-vue-component, now you can create a react component just like it!

Install

yarn global add create-react-component-with-no-config

Usage

create-react-component-with-no-config react-xxx
# or
create-react-component react-xxx
# or type less
crc react-xxx

# you can also create component in place
mkdir react-xxx && cd react-xxx
crc

The folder struture of generated project (no config files!):

structure

Documentation

folder structure

  • src/index.jsx: Your fancy component
  • example/index.jsx: Entry file of your demo

npm scripts

  • yarn example: Run the demo for your component (with Poi)
  • yarn example:build: Build the demo for your component (with Poi)
  • yarn build: Build your component (with Bili)
  • yarn test: Lint and test your component (with Jest)
  • yarn lint: Lint only.

badges

The generated README.md in your project contains the badges of npm version, npm downloads and circleci status.

Contributing

  1. Fork it!
  2. Create your feature branch: git checkout -b my-new-feature
  3. Commit your changes: git commit -am 'Add some feature'
  4. Push to the branch: git push origin my-new-feature
  5. Submit a pull request :D

Author

MIT License

minemine.cc · GitHub @luyilin · Twitter @luyilin12