@syapse/frontend-cookie-cutter v1.3.0

frontend-cookie-cutter

scaffolding for new frontend components

Features

1. Automatic ES6 transpilation via Babel
2. Automatic linting via eslint with Airbnb style guide
3. Automatic testing via Jest
4. Pre-commit hooks for testing, security checks, and outdated components

Conventions

• Adheres to Airbnb's style guide
  • Guide specific to React

Start

1. Clone this repo
2. Edit package.json to match your new component.
3. Edit src/component.js to create your new compoent.
4. Edit src/component.test.js to match your new component.

Developing

1. yarn dev or npm run dev
2. Go to http://localhost:9000/ to view your component.
3. Edit example/index.jsx if you need to alter the entry point in some way during development.
4. Edit config/webpack.config.dev.js to change the webpack dev config.

Testing

1. yarn test or npm test
2. View the Jest output.

Building

1. yarn build_production or npm run build_production to build the production artifacts.
2. Output is in dist/.
3. Edit config/webpack.config.prod.js to change the webpack prod config.

Publishing

1. Make sure your code passes all tests and pre-commit hooks.
2. run npm version (patch|minor|major) depending on the type of change.
3. Push your changes to origin/master via a Pull Request
4. When your change has been merged to master, run npm publish.