This is a README generate which user can quickly and easily generate a README.md file by using a Command line. This application is created by JavaScript and Node.js.
Instructions to get the application run:
1. Download and install Visual Studio Code if user don't have it installed in the computer.
2. Download and install Node.js if user don't have it installed in the computer.
3. Open the terminal, first run npm install + the name of the following npm package dependencies:
* inquirer will prompt user for inputting the information in command line.
* axios will fetch user's information from GitHub API base on GitHub username.
The application itself runs by command node index.js or node index.
Readme Generator is a command-line application that accepts user input. When user prompts for information about the application repository, a high-quality, professional README.md is generated with the title of the project and sections entitled Description, Table of Contents, Installation, Usage, License, Contributing, Tests, and Questions:
1. when user enters the project title, then this is displayed as the title of the README.
2. when user enters a description, installation instructions, usage information, contribution guidelines, and test instructions, then this information is added to the sections of the README entitled Description, Installation, Usage, Contributing, and Tests.
3. when user chooses a license for the application from a list of options, then a badge for that license is added near the top of the README and a notice is added to the section of the README entitled License that explains which license the application is covered under.
4. when user enters the GitHub username, then this is added to the section of the README entitled Questions, with a link to the GitHub profile.
5. when user enters the email address, then this is added to the section of the README entitled Questions, with instructions on how to reach the user with additional questions.
6. when user clicks on the links in the Table of Contents, then it goes to the corresponding section of the README.
This project is under license MIT
Not Available
Not Available
The lists of resources used to complete this challenge:
1. Module 9 Node.js from canvas.
2. Google (https://www.google.ca/)
3. MDN Web Docs (https://developer.mozilla.org/en-US/docs/Web/JavaScript).
4. NPM - inquirer (https://www.npmjs.com/package/inquirer).
5. NPM - axios (https://www.npmjs.com/package/axios).
6. Node.js - fs.writeFile (https://nodejs.org/dist/latestv12.x/docs/api/fs.html#fs_fs_writefile_file_data_options_callback)
7. Node.js - util.promisity() (https://nodejs.org/dist/latest-v12.x/docs/api/util.html#util_util_promisify_original).
8. Shields (https://shields.io/)
9. Choose A License (https://choosealicense.com/licenses/)
10. Supports from instructor, assistant instructor and Tutor.
For any questions, please contact me with the information below:
GitHub: @shanshantina
Email: [email protected]
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent