Skip to content

nhanng19/readme_generator

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

15 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

README Generator

Node.js: Professional README Generator

The application will be invoked by using the following command:

node index.js

LINK TO THE VIDEO

The Process

  • Install inquirer package
  • Install fs module
  • Create index javascript file prompting input for users
  • Create generateMarkdown javascript file writing data to generated readme file

Specific functions of index.js

- Initialize variables importing necessary files and packages
- List prompt and store answers as specific data type in memory
- Generate READme based on user's input

Specific functions of generateMarkdown.js

- Render license badge if user choose license option
- Render license section if user choose license option
- Function rendering data for READme file based on user's input

The Result

After dynamically coding Index.js and generateMarkdownjs , we were able to provide an engaging, efficient, and stuctured Node.js application that generates a professional README file.

This project was uploaded to GitHub at the following repository link: https://github.com/nhanng19/readme_generator

Walkthrough video: https://drive.google.com/file/d/17mvdLqx0fT00417CcV9HXt1qx9cjSI6Z/view