Brikcss Component

A scaffolding / starter repo for brikcss components. Follow these steps to set up a new component.

1. Set up the new component repo & test
2. Update configs / root files
3. Set up dependencies
4. Create the component

Set up the new component repo & test

• [ ] Clone (or fork) this repo.
• [ ] Create repo in GitHub for new component.
• [ ] Configure remote branch tracking as follows:
  • [ ] origin: tracks the new component repo in GitHub.
  • [ ] upstream: tracks this scaffolding repo.

Update configs / root files

• [ ] .browsersync.js:
  • [ ] files property to watch build files.
  • [ ] server property to set the correct baseDir and index values.
  • [ ] Any other browsersync settings as desired.
• [ ] .gitignore.
• [ ] .travis.yml (scripts fields).
• [ ] package.json:
  • [ ] All fields with "component" to the new component name.
  • [ ] description.
  • [ ] keywords.
  • [ ] main and module with the correct entry files.
  • [ ] release and publishConfig with the correct branch/dist-tags.
  • [ ] files with all files necessary for a release.
  • [ ] scripts:
    • [ ] prod:clean paths (and possibly add mkdirp to recreate dist dirs?).
    • [ ] js:watch and js:lint paths.
    • [ ] sass:watch and sass:lint and sass:dist paths.
    • [ ] If the component will have dist files, or if there are any tasks you want the release process to run prior to publishing, add the following NPM script to package.json:

      "prepublishOnly": "npm run prod"

  • [ ] devDependencies.
• [ ] README.md:
  • [ ] Update shields to show data for the new component.
  • [ ] Update the rest of README.md as desired.
• [ ] webpack.config.js to ensure it compiles the correct files / bundles.

Set up dependencies

• [ ] Install NPM packages with npm install.
• [ ] Set up semantic-release by running semantic-release-cli setup.

Note: Semantic release will publish your first release as version 1.0.0, there's no known way to change this. If you want to start at an earlier version (such as 0.0.1), do the following:

• [ ] Update the version in package.json to 0.0.1.
• [ ] Publish your first release manually with npm publish --tag=<tag> --access=public.
• [ ] Update version in package.json back to 0.0.0-development.

Create the component

Directory structure:

• src: Original source code.
• examples: Code or test examples.
• tests: UI and unit tests.
• dist: Files for distribution (if any).
• lib: Helper scripts (i.e., NPM scripts or git hooks).
• docs: Documentation.