0.0.7 • Published 7 years ago

@thinkmill/shed v0.0.7

Weekly downloads
-
License
MIT
Repository
github
Last release
7 years ago

🚲 The Ol' Bike Shed

What

A series of simple scripts (aka recipes) to scaffold up a project with Thinkmill specific conventions.

Prerequisites

node >=8
yarn
# If you don't have it, `brew install yarn`

Usage

$ npx @thinkmill/shed
# or
$ npm i -g @thinkmill/shed

Example

$ mkdir new-project && cd new-project
$ npx @thinkmill/shed

Recipes

Base

Your stock standard TM devDependencies and config files.

# Dir structure
.
ā”œā”€ā”€ .babelrc
ā”œā”€ā”€ .circleci
│   └── config.yml
ā”œā”€ā”€ .editorconfig
ā”œā”€ā”€ .eslintignore
ā”œā”€ā”€ .eslintrc
ā”œā”€ā”€ .gitignore
ā”œā”€ā”€ .prettierrc
ā”œā”€ā”€ __test__
│   └── index.spec.js
ā”œā”€ā”€ package.json
└── yarn.lock

React (I think this needs some work...)

A stripped-down version of create-react-app.

Contributing

It's easy to add or upgrade a recipe. There's 3 places you'll need to add your code: 1. ./src/recipes - Add your recipe to make sure Inquirer knows what to look for. 2. ./src/config/[your-recipe-config] - Amend or add any config to the config files.

Todo

  • Extend it to accomodate different types of 'recipes'
  • Add Inquirer
  • Precommit, prepublish and ci scripts.
  • Publish to npm
  • Get buy-in from everyone to contribute to this repo
  • Watch everyone else flesh this thing out....