epikhighs/buildkit

buildkit

goals

1. Centralize the app infrastructure (tooling and libs needed to build and develop an app) such that the consumers of buildkit are decoupled from maintaining the infrastructure on a project by project basis
2. Provide sensible defaults that can be extended
3. First class support for Webstorm's builtin tools/plugins (e.g. remote debugging, running the tests or apps in Webstorm's runner etc.)
4. "Absolute" import/require paths relative to /src directory (e.g. import foo from 'src/foo)

usage

Haven't published to NPM yet, but for now can experiment by installing via git url.

  "devDependencies": {
    "buildkit": "git://github.com/epikhighs/buildkit.git"
  }

conventions

1. agreed upon directory structure and file naming scheme
2. project files go into /src
3. test files are co-located with source files and ends with*.test.js
4. copies over config from build repo or make it read config from node_modules. Can prob create a node_modules/.binscript that copies over base configs from node_modules. This script would be run as part of the npm run prod-build step so on CI build server it would automatically get the config it needs. And in webpack config's use case, can make webpack config point to a file that provides overrides.
5. .babelrc, webpack config
6. need a node.js script that installs common packages. Can probably read from a config file that's there per project that provides blacklist/whitelist on which packages it needs.

initial project setup

1. create a repo
2. npm init
3. npm i -D git://github.com/epikhighs/buildkit.git
4. this step auto-installs all package.json dependencies from buildkit
5. npx buildkit init
6. copies over base configs (babel/webpack/storybook)
7. update package.json's npm scripts
8. "server": "webpack-dev-server --config ./webpack.base.babel.js",

packages most react projects will need

• initial scope

  • webpack
  • babel

• foundational

  • babel
  • cross env
  • npm-check
  • react hot loader
  • storybook
  • webpack

• code quality

  • chai
  • eslint
  • enzyme
  • istanbul/nyc
  • mocha
  • sinon

• run time libs

  • ramda
  • react
  • recompose
  • styled comp

• optional libs

  • redux
  • redux dev tool
  • redux saga
  • reselect

project notes

• must install packages to dependencies and not devDependencies for all packages that are intended to be auto installed into consumer's repo, else the consumer of buildkit can't automatically get the packages in buildkit when running npm i from the consumer's repo. Typical example will be webpack and babel should be auto installed into consumer's repo so those will go into the run-time dependencies. But maybe I want to run some mocha tests to test out buildkit specific behavior, then mocha should be installed to devDependencies. But mocha is a bad example b/c I'd want mocha to be auto installed too as the testing framework of choice so that'd actually go inside dependencies.