https://github.com/khumbulani9/es6-node.js-professional-readme-generator
In this Challenge, i was able to build a command-line application that dynamically generates a professional README.md file from a user's input.
https://github.com/khumbulani9/es6-node.js-professional-readme-generator
bootstrap command commandline-interface css es6 html javascript nodejs
Last synced: 3 months ago
JSON representation
In this Challenge, i was able to build a command-line application that dynamically generates a professional README.md file from a user's input.
- Host: GitHub
- URL: https://github.com/khumbulani9/es6-node.js-professional-readme-generator
- Owner: khumbulani9
- License: mit
- Created: 2024-02-14T23:48:22.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-10-28T13:29:17.000Z (8 months ago)
- Last Synced: 2024-10-28T16:59:35.006Z (8 months ago)
- Topics: bootstrap, command, commandline-interface, css, es6, html, javascript, nodejs
- Language: JavaScript
- Homepage: https://khumbulani9.github.io/ES6-Node.js-Professional-README-Generator/
- Size: 11.8 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ES6-Node.js-Professional-README-Generator
## Description of the Assignment
The application was reated using node.js to generate a professional README.md file with use of the command line interface. This technique is highly beneficial for developers as it reduces the amount of time it may take developer to write code and allows for them to devote most of their time creating, maintaining and updating applications.
By the use of inquirer (node package manager) this application takes the user through a series of prompts, asking them their name, title of their application, application description, installation instructions, usage information, contribution guidelines, test instructions, what type of license they want their application to be covered under, as well as their GitHub handle, and primary email. Once all prompts are answered, the application generates a professional README.md markdown file with the users inputs.
The application helped me learn alot with regards to backend technology such as node.js and allowed me to have a greater understanding of how back end developers use this technology to problem solve without the use of user interface or a live browser.
## Live Screen Recording of Application Functionality
(https://drive.google.com/file/d/1mgV65_9nqOF7iwo83F-RZEGkW8_FC4uU/view)
## Screenshots
(
("
("
(https://github.com/khumbulani9/ES6-Node.js-Professional-README-Generator/assets/146132836/ac66b5bd-e8ac-42c1-a784-55b5414aaff1)
## Technologues Used
This project is powered by Node.js v16, and utilizes the inquirer v8.2.4 (node package manager), and file system module (node package manager).
## Installation
Clone the repo: git clone
Open in VS Code. If you do not have VS code you must install it.
Using the terminal, install node.js v16.
Once node.js v16 is installed, in the terminal, utilize the command npm init -y to initialize and create a package where project files will be stored.
Next, use the terminal to run the command npm i [email protected] to install v8.2.4 of the inquirer.
To run the application, within the terminal, type the command node index.js.
## Contact-link URL to GitHub repository
https://github.com/khumbulani9/ES6-Node.js-Professional-README-Generator/edit/main/README.md