/teamprofilemaker

Primary LanguageJavaScriptMIT LicenseMIT

teamprofilemaker

Table Of Contents

*Description

*installation

*requirements

*Usage Instructions

*Running the tests

*Contributing

Description

The team profile maker app runs from the command line in node and allows the user to input members of their development team , it then generates an html page with each member of the development team listed along with their useful information.

Installation

this project runs form the command line. to install it the user must fork the git hub repo, insure that all dependencies have been installed then navigate to the Develop directory inside the project and run node app.js.

Requirements

This application requires that node.js is installed , along with the inquirer package . all of the other dependencies are standard to node.

Usage Instructions

once you run app.js you will be prompted to chose the role of the member of your development team you would like to start with. Once you chose from engineer, intern or manager you will be prompted to enter the information about the chosen employee. once you have entered all of your team memebers, you will select the "show team" option from the list. when you hit enter an html file will be created in the output directory titled "team.html" this is your team profile.

Running the tests

to run the tests associated with this project you must install jest as a dependency. once that is installed you can run the command "npm run test" from the command line while inside the application directory.

Contributing

If you would like to contribute to this project you may do so by submitting a pull request. For more complicated changes please contact the repository creator.

Additional questions

contact the creator at jdlevish@gmail.com or Jdlevish on github.com

licensing

this project is covered under the MIT License for more info view the license.txt