https://github.com/thinkmill/shed
🚲 Find all your bike shedding needs under one roof
https://github.com/thinkmill/shed
Last synced: 11 months ago
JSON representation
🚲 Find all your bike shedding needs under one roof
- Host: GitHub
- URL: https://github.com/thinkmill/shed
- Owner: Thinkmill
- License: mit
- Created: 2018-04-25T02:00:33.000Z (almost 8 years ago)
- Default Branch: develop
- Last Pushed: 2018-05-28T00:42:13.000Z (over 7 years ago)
- Last Synced: 2025-03-25T09:11:24.719Z (11 months ago)
- Language: JavaScript
- Homepage:
- Size: 86.9 KB
- Stars: 2
- Watchers: 23
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 🚲 **The Ol' Bike Shed**
## What
A series of simple scripts (aka _**recipes**_) to scaffold up a project with Thinkmill specific conventions.
## Prerequisites
```sh
node >=8
yarn
# If you don't have it, `brew install yarn`
```
## Usage
```sh
$ npx @thinkmill/shed
# or
$ npm i -g @thinkmill/shed
```
## Example
```sh
$ mkdir new-project && cd new-project
$ npx @thinkmill/shed
```
## Recipes
#### Base
Your stock standard TM `devDependencies` and config files.
```sh
# 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](https://github.com/facebook/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
- [x] Extend it to accomodate different types of 'recipes'
- [x] Add [Inquirer](https://github.com/SBoudrias/Inquirer.js)
- [x] Precommit, prepublish and ci scripts.
- [x] Publish to npm
- [ ] Get buy-in from everyone to contribute to this repo
- [ ] Watch everyone else flesh this thing out....