#9-cli-good-readme-generator

READ ME Generator executed via Command Line Interface (CLI) in Terminal.

Github Repository Page: https://github.com/palowenstein/cli-good-readme-generator

Github Deployment Page: N/A - App is to be executed in Terminal via CLI.

Table of Contents

• GIF
• Overview
• Details
• Instructions
• Screenshots
• Video
• References
• License
• Contact

GIF

Overview

• Read Me Generator executed in Terminal via (CLI) Command Line Interface.


• Application behaves accordingly to standard (“good”) practices and dynamically generates a professional README markdown file.


• User is prompted to respond to each question, one at a time.


• All questions are answered via a character string except for the licence, which is choice driven.


• The goal of the application is its simplicity of use and its overall time saving for the final user.

Details

• A .gitignore file is present at the root level to prevent the upload of node_modules, .DS_Store.


• The included package.json file includes all dependencies if the user wants to run ‘npm install’ instead of the instructions below

Instructions

• In Terminal, locate the application folder and enter into it via the ‘cd’ command: cd hw9-cli-good-readme-generator


• Run the ‘npm init’ command to fill the package json with the application information (screenshot #1).
  
• Run the ‘npm inquirer’ to install the inquirer dependencies (screenshot #2).


• Run the ‘node index.js’ command to start the application in Terminal (GIF/MP4).


• While still in Terminal, answer the following prompts (GIF/MP4):
  
  
  
  1. GitHub Username
  
  
  2. E-Mail
  
  
  3. Title
  
  
  4. Description
  
  
  5. Licence
  
  
  6. Installation
  
  
  7. Tests
  
  
  8. Usage
  
  
  9. Contributions
  
  
  
  
• Once all questions have been answered, a “README — Title (based on the title entered).md” will be generated in the application folder (screenshot #3).

Refer to index.js (javascript file) for code dissection.

Screenshots

CLI Good Read Me Generator (Screenshot #1: npm init)

CLI Good Read Me Generator (Screenshot #2: npm install inquirer)

CLI Good Read Me Generator (Screenshot #3: Generated Read Me Markdown)

Video

CLI Good Read Me Generator Prompt Flow (MP4)

References

• Node.js


• Javascript


• Inquirer


• ES6+


• Axios (optional - for GitHub username verification)

License

MIT License | Copyright © [2020] Pierre André Lowenstein

Contact

[www] pierreandrelowenstein.com
|
Send me a ‘courriel’