https://github.com/victorandcode/tblue
📘 Trello blueprints, scaffolding for trello boards (a.k.a. yeoman for trello)
https://github.com/victorandcode/tblue
cli javascript scaffolding trello
Last synced: about 2 months ago
JSON representation
📘 Trello blueprints, scaffolding for trello boards (a.k.a. yeoman for trello)
- Host: GitHub
- URL: https://github.com/victorandcode/tblue
- Owner: victorandcode
- Created: 2019-01-08T20:30:11.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2022-12-06T14:55:05.000Z (over 3 years ago)
- Last Synced: 2023-03-21T04:25:37.317Z (over 3 years ago)
- Topics: cli, javascript, scaffolding, trello
- Language: JavaScript
- Homepage:
- Size: 6.9 MB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 17
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
Awesome Lists containing this project
README
tblue 📘
[](https://twitter.com/intent/tweet?text=Trello%20Scaffolding%20CLI%20tool!%20Tblue&url=https://github.com/victor-cordova/tblue&hashtags=trello,scaffolding,yeoman,templates,developers,github)
[](https://opensource.org/licenses/MIT)
[](https://github.com/dwyl/esta/issues)
Trello blueprints, scaffolding for trello boards (a.k.a. yeoman for trello)
**Result**:
## 💡 Motivation
If you use trello a lot, it's likely that you have common tasks based on past experience and also custom cards for a given project. Wouldn't it be nice to have some sort of blueprint or template we could use to bootstrap our boards? This project aims to solve this need.
## 🔧 Prerequisites
This project requires 2 environment variables set. Please add them to your .bash_profile or wherever they are needed for your environment. Next you'll find which variables you need to set and what value you should use for each one.
(You can optionally just run `tblue` and the cli will guide you 😉)
### TRELLO_API_KEY
Log into trello and copy the developer key from https://trello.com/app-key. Use that value for this environment variable.
### APP_TOKEN
Use your api key from last step and replace **API_KEY** inside the next url https://trello.com/1/authorize?key=API_KEY&name=tblueScaffoldingForTrello&expiration=never&response_type=token&scope=read,write
Now copy/paste the full url into your browser
Grant access to the script so you get a token, only you know what this token is so only your local instance of `tblue`
will use it.
Now place the token as the value for this environment variable.
## 🏃 How to run
```sh
npm install -g tblue
tblue
```
## 📜 Workflow
1. Choose a name for your board
2. Choose which blueprint you want to use
3. Start answering Y/n for each question in the blueprint
4. Start adding specific "features" for your project
5. Open your new board from the terminal 👶
## CLI options
|Command option| Description|
|---------------|-----------|
|`-h` or `--help`|Shows all available command line options|
|`-c` or `--custom-blueprints-folder`| Allows passing a folder containing one or multiple blueprints ([see Custom blueprints](#custom-blueprints)). Only the files immediately inside the folder that have a `.blueprint.json` extension and have a valid template will be evaluated|
## Custom blueprints
The custom blueprints you create must have the following format. **If they don't, they will not show up in the blueprints selection screen**.
```js
{
//Name that will be prompted in the CLI
"name": "Simple API",
//The name you give to features for your particular blueprint. e.g. feature, endpoint, article, etc
"unitOfWork": "feature",
//Questions that could generate a card according to your project's need
"questions": [
{
"content": "Will you be using Docker?",
"cardToGenerate": {
"name": "Create Docker configuration"
}
},
],
//These are cards that will always be generated when you use this blueprint
"cards": [{"name": "Repository configuration"}]
}
```
**Note: If you want store your custom blueprints without having to pass alwas the `-c` flag. You can store them in the `~/.blueprints` folder**
## Running locally
```sh
npm install
npm start
```
## Run tests
```sh
npm test
```
## [Contributing](./CONTRIBUTING.md)
## Compatibilty
Emojis don't show correctly in windows' cmd 💔