The aim of this project is to generate a README file using Node JS and inquirer package. The inquire package is used to prompt the user with questions. Based on the answers given from the user, a README file is generated inside the docs directory of this project.
The Project contains the file questions.js where the questions to ask to the user are; createFile.js - that creates the README file in the output folder and generateMarkdown.js that generates the markdown based on the answers given to the questions.
In the question.js, validation for the URL and the email address is performed. The application will not continue the execution if the data entered for the respective answers is not an URL or/and email.
npm init
npm install inquirer
Manual tests have been performed for this project
- Github Project Repository
- Github Project URL
- README link The generated README file can be found inside the docs directory in the project tree
- Explanatory Video