This application was created using node.js to generate professional README.md docs from the command line, and aims to cut down on the amount of time developers are using to write their README.md files. This way more of their time can be devoted to creating, maintaining, and updating their 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. This was the first application I have created using a backend technology (node.js), and gave me greater insight into the way back end developers problem solve without the use of a user interface or live browser. Through building this application I learned how to import the libraries inquirer and file system into a node application, the use of prompts within the command line, template literals and arrow functions (ES6 syntax), and continued to build on all previous programming knowledge I have gained so far (for this application, mainly the utilization of conditionals statements).
https://drive.google.com/file/d/1hC13oWMKoX55i7MBL6HKU7-UDdcaIn_d/view
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).
-
Clone the repo: git clone https://github.com/rmessett15/README-Generator.git
-
Open in VS Code. If you do not have VS code you must install it.
-
Using the terminal, install node.js v16. If you have homebrew, the command should look like the following (brew install node@16), however this may vary and the documentation should be consulted.
-
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 inquirer@8.2.4 to install v8.2.4 of the inquirer.
-
To run the application, within the terminal, type the command node index.js.
Worked with a close friend of mine within the developer community to pseudo-code this application outline (Brian Dillman). Also met with a tutor, (Phillip Loy) to work through appending the licensing badges to the README.md document, as well as on some errors I was having with my anchor tags providing the proper link to the users email input.
Features of this application include the users ability to generate a professional README.md document straight from the command line. The user will answer a series of prompts about their application, and then a README.md markdown file will be generated based on their responses. Features within the README.md file include a licensing badge which will be appended near the top of the page based on what license the user would like their application to be covered under. As well as a table of contents which includes links to the various sections of the README.md document, that when clicked take the user to the corresponding section. Lastly their is a questions section at the bottom of the generated README.md document where links to the application authors GitHub and email are provided (when clicked, the user will be taken to the authors GitHub account, or to a blank email document where the author is automatically entered as the recipient).
Open to collaboration, if you choose to do so open an issue and modify any changes you would like to see on a feature branch and wait for approval before merging to the main branch.