/xstream-boilerplate

A boilerplate for getting started with Cycle.js Diversity

Primary LanguageJavaScriptGNU General Public License v3.0GPL-3.0

Cycle.js Diversity Boilerplate

Coverage Status CircleCI David David Github All Releases

Get it!

$ git clone https://github.com/TylorS/xstream-boilerplate.git PROJECT_NAME
$ cd PROJECT_NAME
$ rm -rf .git
$ git init
$ git remote add origin https://github.com/USERNAME/PROJECT_NAME
# create your github repo
# setup CircleCI
# turn on LGTM
$ bash scripts/add_issue_labels.sh
$ npm install
# Enjoy Cycle.js and xstream

Features

  • Cycle.js Diversity
  • XStream
  • Babel
  • Mocha + power-assert - unit testing
  • Travis CI - continuous integration
  • Isparta - code coverage
  • ESLint + eslint-config-standard - code linting
  • husky + validate-commit-msg + commitizen - enforce good commit messages <3
  • conventional-changelog - Generate a changelog from your nice commit messages
  • Github Issue and Pull Request templates
  • LGTM sample MAINTAINERS file
  • Webpack 2 - bundling
  • Hot Module Reloading - using cycle-hmr - Thank you @Cmdv and @whitecolor
  • BrowserSync - Make testing mutliple browsers easy peasy! Thank you @stevenmathews
  • Script for making better Github issue labels

Libraries included by default

TODO

  • CSS Modules - better CSS
  • SASS/SCSS + Modules - betterer CSS
  • Better Documentation, more links, etc
  • add markdown-doc-test
  • More everything :)