Improving repos content
This commit is contained in:
		
							parent
							
								
									b3c4e7657a
								
							
						
					
					
						commit
						7d1ce52034
					
				
					 10 changed files with 31 additions and 204 deletions
				
			
		|  | @ -13,7 +13,7 @@ const markdownClassMapping = { | |||
|   h6: ['font-bold', 'mt-2'], | ||||
|   a: ['text-pink-700', 'hover:underline', 'focus:text-white', 'focus:bg-pink-700', 'focus:outline-link'], | ||||
|   p: ['mb-2', 'text-gray-500'], | ||||
|   img: ['max-w-full', 'rounded-lg'], | ||||
|   img: ['max-w-full', 'rounded-lg', 'max-h-600px'], | ||||
|   ul: ['list-disc', 'ml-4'], | ||||
| }; | ||||
| 
 | ||||
|  |  | |||
							
								
								
									
										
											BIN
										
									
								
								img/content/my-spells.png
									
										
									
									
									
										Normal file
									
								
							
							
						
						
									
										
											BIN
										
									
								
								img/content/my-spells.png
									
										
									
									
									
										Normal file
									
								
							
										
											Binary file not shown.
										
									
								
							| After Width: | Height: | Size: 133 KiB | 
|  | @ -1,5 +1,6 @@ | |||
| --- | ||||
| tags: repos | ||||
| templateEngineOverride: md | ||||
| title: blabber-comic | ||||
| description: Converts chat logs to comics. | ||||
| date: 2018-12-30 | ||||
|  | @ -7,8 +8,6 @@ date: 2018-12-30 | |||
| 
 | ||||
| [Fork on Gitlab](https://gitlab.com/gaiety/blabber-comic) | ||||
| 
 | ||||
| # Blabber-Comic | ||||
| 
 | ||||
| [](https://badge.fury.io/js/blabber-comic) | ||||
| 
 | ||||
| ## Sample | ||||
|  | @ -19,90 +18,7 @@ date: 2018-12-30 | |||
| 
 | ||||
| Powered by Node and a node-canvas a comic can automatically be generated from a json array of users/text and some characters/backgrounds to be chosen at random. | ||||
| 
 | ||||
| ## How to use it from the CLI | ||||
| 
 | ||||
| ### Installing | ||||
| 
 | ||||
| Note: Your system may need some [compiled dependencies for canvas to work](https://github.com/Automattic/node-canvas#compiling). | ||||
| 
 | ||||
| `npm install -g blabber-comic` | ||||
| 
 | ||||
| ### Using | ||||
| 
 | ||||
| ``` | ||||
| $ blabber | ||||
| $ Who?: Glen | ||||
| $ Said What?: Test 1 | ||||
| $ Another? (y/n) y | ||||
| $ Who?: Sarah | ||||
| $ Said What?: Test 2 | ||||
| $ Another? (y/n) y | ||||
| $ Who?: Glen | ||||
| $ Said What?: Test 3 | ||||
| $ Another? (y/n) n | ||||
| $ Generating Comic... | ||||
| $ [ Comic Generated @ comics/1.png ] | ||||
| ``` | ||||
| 
 | ||||
| ### Additional Options | ||||
| 
 | ||||
| ``` | ||||
| $ blabber --path ~/Pictures | ||||
| ``` | ||||
| 
 | ||||
| 
 | ||||
| ## How to use it in other projects | ||||
| 
 | ||||
| ### Generate base64Data | ||||
| 
 | ||||
| ```javascript | ||||
| const blabbercomic = require('blabber-comic'); | ||||
| let messages = [] // Array of messages... | ||||
| 
 | ||||
| blabbercomic(messages).then(response => { | ||||
|   console.log('Generated comic as base64 data', response); | ||||
| }).catch(error => { | ||||
|   throw error; | ||||
| }); | ||||
| ``` | ||||
| 
 | ||||
| ### Save as file with `fs` | ||||
| 
 | ||||
| Example included in project. Clone then run `npm run test`. | ||||
| 
 | ||||
| ```javascript | ||||
| const blabbercomic = require('blabber-comic'); | ||||
| const fs = require('fs'); | ||||
| let messages = [] // Array of messages... | ||||
| 
 | ||||
| blabbercomic(messages).then(response => { | ||||
|   let base64Data = response.replace(/^data:image\/png;base64,/, ''); | ||||
| 
 | ||||
|   fs.writeFile('./storage/comics/comic.png', base64Data, 'base64', error => { | ||||
|     if (error) console.error('Uhoh...', error); | ||||
|     else console.log('Saved file as `comic.png`'); | ||||
|   }); | ||||
| }).catch(error => { | ||||
|   throw error; | ||||
| }); | ||||
| ``` | ||||
| 
 | ||||
| ### Customizing characters and backgrounds | ||||
| 
 | ||||
| ```javascript | ||||
| const blabbercomic = require('blabber-comic'); | ||||
| let backgrounds = ['./assets/backgrounds/1.png', './assets/backgrounds/2.png']; | ||||
| let characters = ['./assets/characters/1.png', './assets/characters/2.png', './assets/characters/3.png']; // Provide at least 3 | ||||
| let comicSize = 500; // in px square | ||||
| let borderColor ='#CCCCCC'; | ||||
| let font = 'Impact'; | ||||
| let textColor: '#000000'; | ||||
| 
 | ||||
| let messages = [] // Array of messages... | ||||
| let config = { backgrounds, characters, comicSize, borderColor, font, textColor }; | ||||
| 
 | ||||
| blabbercomic(messages, config); | ||||
| ``` | ||||
| Can be used as a CLI by itself or plugged into other NodeJS projects. Its original use was as a Discord bot plugin on a personal server for fun. | ||||
| 
 | ||||
| --- | ||||
| 
 | ||||
|  |  | |||
|  | @ -1,5 +1,6 @@ | |||
| --- | ||||
| tags: repos | ||||
| templateEngineOverride: md | ||||
| title: ember-select-light | ||||
| description: The simplest Ember <select> there is. | ||||
| date: 2020-11-05 | ||||
|  |  | |||
|  | @ -1,5 +1,6 @@ | |||
| --- | ||||
| tags: repos | ||||
| templateEngineOverride: md | ||||
| title: "json-query-chain" | ||||
| description: Chain queries onto POJOs to return precise results. | ||||
| date: 2018-02-23 | ||||
|  | @ -7,11 +8,9 @@ date: 2018-02-23 | |||
| 
 | ||||
| [Fork on Gitlab](https://gitlab.com/gaiety/json-query-chain) | ||||
| 
 | ||||
| # json-query-chain | ||||
| [](https://badge.fury.io/js/json-query-chain) | ||||
| 
 | ||||
| [](https://travis-ci.org/sharpshark28/json-query-chain) [](https://badge.fury.io/js/json-query-chain)  [](https://codeclimate.com/github/sharpshark28/json-query-chain/maintainability) | ||||
| 
 | ||||
| Chain queries onto POJOs to return precise results. | ||||
| 100% test covered and developed with Test-Driven Development. | ||||
| 
 | ||||
| ## Usage | ||||
| 
 | ||||
|  |  | |||
|  | @ -1,5 +1,6 @@ | |||
| --- | ||||
| tags: repos | ||||
| templateEngineOverride: md | ||||
| title: my_spells | ||||
| description: Your personal D&D 5e Spellbook. | ||||
| date: 2019-01-27 | ||||
|  | @ -7,14 +8,14 @@ date: 2019-01-27 | |||
| 
 | ||||
| [Fork on Gitlab](https://gitlab.com/gaiety/my_spells) | ||||
| 
 | ||||
| _Note_: Since the release of Wizards of the Coast's latest online tools, I've discontinued this mobile app. But, I learned a lot along the way in making this :) | ||||
| 
 | ||||
| # My Spells | ||||
| **_Discontinued_: Since the release of Wizards of the Coast released [dndbeyond.com](https://www.dndbeyond.com/), I've discontinued this mobile app. But, I learned a lot along the way in making this :)** | ||||
| 
 | ||||
| My Spells is an open source web-based application to elegantly view spells and save them to your local spellbook.  | ||||
| 
 | ||||
| [](https://play.google.com/store/apps/details?id=io.cordova.myspells) | ||||
| 
 | ||||
|  | ||||
| 
 | ||||
| ## License | ||||
| 
 | ||||
| Open Game License v1.0a Copyright 2000, Wizards of the Coast, Inc. | ||||
|  |  | |||
|  | @ -1,5 +1,6 @@ | |||
| --- | ||||
| tags: repos | ||||
| templateEngineOverride: md | ||||
| title: sortable-recipes | ||||
| description: A sample project for my EmberConf 2020 talk. Leverages Ember Octane and is fully test driven. Includes the RevealJS presentation and a simple Python backend. | ||||
| date: 2020-03-21 | ||||
|  |  | |||
|  | @ -1,5 +1,6 @@ | |||
| --- | ||||
| tags: repos | ||||
| templateEngineOverride: md | ||||
| title: svgdir2sprite | ||||
| description: Creates a spritesheet from a directory of svgs.  | ||||
| date: 2019-01-03 | ||||
|  | @ -7,8 +8,6 @@ date: 2019-01-03 | |||
| 
 | ||||
| [Fork from Gitlab](https://gitlab.com/gaiety/svgdir2sprite) | ||||
| 
 | ||||
| # svgdir2sprite | ||||
| 
 | ||||
| [](https://www.npmjs.com/package/svgdir2sprite) | ||||
| 
 | ||||
| Creates a spritesheet from a directory of svgs. Can return the results directly or write to a spritesheet svg file. Node based and powered by [svg2sprite](https://github.com/mrmlnc/svg2sprite). | ||||
|  |  | |||
|  | @ -1,5 +1,6 @@ | |||
| --- | ||||
| tags: repos | ||||
| templateEngineOverride: md | ||||
| title: team-cli | ||||
| description: Automate all the things with a team-centric CLI. Abstract away annoying day-to-day tasks and eliminate tribal team knowledge by building your team their very own CLI. | ||||
| date: 2019-09-01 | ||||
|  | @ -12,117 +13,23 @@ pinned: true | |||
| 
 | ||||
| [](https://badge.fury.io/js/team-cli) | ||||
| 
 | ||||
| Automate all the things with a team-centric CLI. Abstract away annoying day-to-day tasks and eliminate tribal team knowledge by building your team their very own CLI. | ||||
| A tool built for teams who are tired of passing around bash aliases, digging through getting started documentation or trying to memorize complex commands. With team-cli you can easily build your own [NodeJS powered](https://nodejs.org/en/) globally installed [npm](https://www.npmjs.com/) package complete with `--help` support. | ||||
| 
 | ||||
| ### Getting Started | ||||
| 
 | ||||
| #### Initialize Project | ||||
| Prentending our team name is **The Cool Kids** we can create the following team-cli of `cool`: | ||||
| 
 | ||||
| ```bash | ||||
| mkdir teamname-cli | ||||
| cd teamname-cli | ||||
| git init | ||||
| npm init | ||||
| npm install --save team-cli | ||||
| $ cool --help | ||||
| 
 | ||||
| Usage: index [options] [command] | ||||
| 
 | ||||
| Options: | ||||
|   -h, --help   output usage information | ||||
| 
 | ||||
| Commands: | ||||
|   start   Builds and serves application locally | ||||
|   reset   Clears out local temp files, resetting to a clean state | ||||
|   deploy <environment>  Builds and deploys application to specified environment | ||||
| ``` | ||||
| 
 | ||||
| #### Create Bin index.js | ||||
| 
 | ||||
| Then in an `index.js` you could write the following: | ||||
| 
 | ||||
| ```javascript | ||||
| #!/usr/bin/env node | ||||
| 
 | ||||
| const { resolve } = require('path'); | ||||
| const cli = require('team-cli'); | ||||
| 
 | ||||
| const commandsDir = resolve(__dirname, 'commands'); | ||||
| cli(commandsDir); | ||||
| ``` | ||||
| 
 | ||||
| #### Point to Bin index.js in Package | ||||
| 
 | ||||
| Then customize your `package.json` to include a path to the bin: | ||||
| 
 | ||||
| ```json | ||||
| "bin": { | ||||
|   "NAME_OF_TOOL": "./index.js" | ||||
| } | ||||
| ``` | ||||
| 
 | ||||
| #### Create Commands | ||||
| 
 | ||||
| Then you may make a `commands` directory with files like `command-foo.js`: | ||||
| 
 | ||||
| ```javascript | ||||
| const run = require('team-cli/terminal'); | ||||
| const { resolve } = require('path'); | ||||
| 
 | ||||
| const script = resolve(__dirname, 'foo.sh'); // also supports bash .ps1 scripts | ||||
| 
 | ||||
| const action = async param => { | ||||
|   await run(script, param) | ||||
|   // Or, run any Node code you wish | ||||
| }; | ||||
| 
 | ||||
| module.exports = { | ||||
|   title: 'foo <param>', | ||||
|   description: 'Calls foo', | ||||
|   action, | ||||
| } | ||||
| ``` | ||||
| 
 | ||||
| #### Try it out! | ||||
| 
 | ||||
| ```bash | ||||
| node ./index.js --help | ||||
| ``` | ||||
| 
 | ||||
| ## Options | ||||
| 
 | ||||
| Any command can export the following options: | ||||
| 
 | ||||
| ```javascript | ||||
| { | ||||
|   title: 'foo', // or 'foo <required_param>' or 'foo [optional_param]' | ||||
|   action: (param) => {} // function with param as a string or undefined | ||||
|   description: 'Calls foo', // optional | ||||
|   alias: 'f', // optional | ||||
|   option: ['-f, --force', 'Forces something to happen'], // optional, this will become available globally not just per-command | ||||
| } | ||||
| ``` | ||||
| 
 | ||||
| ### For Your Users | ||||
| 
 | ||||
| At any time a `--help` or `-h` may be passed to log commands to the console. | ||||
| 
 | ||||
| #### Prompts | ||||
| 
 | ||||
| Optionally, you may find it useful to walk users through a guided CLI experience with prompts to your users. I suggest [prompts](https://www.npmjs.com/package/prompts) for this task, but any tool of your choice will work within an action. | ||||
| 
 | ||||
| #### Example usage with prompts: | ||||
| 
 | ||||
| ```javascript | ||||
| const action = async (cmd) => { | ||||
|   if (!cmd) { | ||||
|     let { value: cmdResponse } = await prompts({ | ||||
|         type: 'text', | ||||
|         name: 'value', | ||||
|         message: 'Which git command would you like to run?', | ||||
|     }); | ||||
|     cmd = cmdResponse | ||||
|   } | ||||
|   await run(`git ${cmd}`, '~/aCoolRepo'); | ||||
| }; | ||||
| ``` | ||||
| 
 | ||||
| #### Logging | ||||
| 
 | ||||
| The environment's log level can be changed with `process.env.LOG_LEVEL` to any of [winston's](https://github.com/winstonjs/winston) supported log levels including `verbose`. | ||||
| 
 | ||||
| To customize where logs are saved, pass a second param in your `index.js`'s `cli` call like so: | ||||
| 
 | ||||
| ```javascript | ||||
| cli(commandsDir, logsDir) | ||||
| ``` | ||||
| The sky is the limit here! What's great is that once a team member has the tool installed they can see what options are available to them in an interactive way without having to dig around for answers. Give it a try! | ||||
| 
 | ||||
|  |  | |||
|  | @ -6,6 +6,9 @@ module.exports = { | |||
|       outline: { | ||||
|         link: ['1px dashed rgba(190, 24, 93)', '2px'], | ||||
|       }, | ||||
|       maxHeight: { | ||||
|         '600px': '600px', | ||||
|       }, | ||||
|     }, | ||||
|   }, | ||||
|   variants: { | ||||
|  |  | |||
		Loading…
	
	Add table
		
		Reference in a new issue
	
	 Ava Gaiety Wroten
						Ava Gaiety Wroten