TheyCallMeMattyD/template-engine-employee-summary

A command-line tool that creates a summary of employees.

   

template-engine-employee-summary

Description

A command-line tool that creates a summary of employees.

Table of Contents

1. Title
2. Description
3. Installation
4. Usage
5. License
6. Contributing
7. Tests
8. Questions?

Installation

1. Be sure you've installed npm (node project manager) and node.js on your system.
2. Ensure the follow dependencies are installed by entering the following code in your terminal:
   a. npm i inquirer
   b. npm i path
   c. npm i fs
   d. npm i jest
   e. npm i test
3. To run the test verifications, from the root directory enter 'npm run test'.

Usage

Simply answer each question as they appear and press 'Enter' to proceed to the next question.

1. To run the employee summary generator, enter 'node app.js' ... then just start answering the questions!
2. To view the summary generator results, please navigate to the team.html file, right click, and select 'view in default browser', OR - follow the link here:
   https://theycallmemattyd.github.io/template-engine-employee-summary/output/team.html

License

This application is covered under the MIT License

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

Tests

Here's a GIF of the generator being executed:

Here's a screenshot of the test validations being executed.

Questions

Please direct all questions to: TheMattyD@outlook.com
Check out my GitHub Profile @ https://github.com/TheyCallMeMattyD