Skip to content

A nodeJS application that uses the NPM package inquirer to prompt users, to generate simple READMEs.

License

Notifications You must be signed in to change notification settings

Kohl1998/Readme-generator

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

22 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Readme-generator

Description

This is a command line application that runs using Node, and NPM packages such as Inquirer which I used to prompt users with an array of objects for the questions.

The purpose of this README, is to help developers generate simple README's with the neccessary information for the project.

During the application I really got to see how beneficial NPM & template literals were.

Installation

For this application I was provided with the starter code with contained the main JS file, package.JSON, and acceptance criteria.

Afterwards, I installed the correct packages such as Inquirer so that my prompts within the JS file would run on Node; I did this by running a NPM install command.

Finally, I setup a remote repo on Github to work from, which I then cloned to my local repository so I can have the two in sync.

Screenshot

NodeJS.jpg

Credits

I used 'Slack' for support - https://slack.com/intl/en-gb I used 'NPMJs' for support - https://www.npmjs.com/package/inquirer I used 'Post Images' for support - https://postimages.org/

License

License: MIT

Features

As a developer or user, to access this application you will need to clone the repo on your local machine, with Node installed, and the correct packages i.e Inquirer so the prompts will run.

The main feature of this application is that you can generate a simple README file, running Javascript on the backend.

See link below ↓

Terminal.jpg

video

Nodejs.preview.short.mp4

About

A nodeJS application that uses the NPM package inquirer to prompt users, to generate simple READMEs.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published