micheqn3 / team-profile-generator

This application renders a team profile for the user based on user input and is run through the command line. The user will choose a team manager first. Then they will be prompted to add as many engineers or interns they want for their team. Once they decide to finish building their team, the rendered HTML will be found in /dist folder.

Team Profile Generator

This repository contains a team profile generator that is run through the command line using Node.js. The application uses the inquirer package to present a set of questions to the user about each employee in their team, which will be categorized into these classes: Employee (parent class), Engineer, Intern, and Manager.

The prompts will continue to ask the user whether they want to add another engineer, intern, or finish building their team. If they choose to finish building their team, the application will retrieve the user data and render an HTML document that lists the profiles of each team member, with their respective information.

Installation

1. Make sure you have Node.js to run the application
2. Clone this repo

HTTPS: https://github.com/micheqn3/team-profile-generator.git
SSH: [e-mail]:micheqn3/team-profile-generator.git

3. Install the NPM packages

npm install

4. Run the application in command line

node index.js

This repository contains:

• index.js - This file initializes a new Application object and starts the application.

• lib/ Application.js - This file contains the class Application, which controls the overall flow of the application and renders the HTML file based on user input.

• lib/ Employee.js, Engineer.js, Intern.js, Manager.js - These files contain the specific properties and methods for each class.

• src/ questions.js - This file contains the prompts that will be shown to the user using inquirer.

• src/ template.js - This file contains helper templates to render the HTML file.

• test/ - These files contains unit tests for Employee.js, Engineer.js, Intern.js, and Manager.js

• dist/ sample.html - Rendered HTML generated by the application.

• dist/ style.css - Style sheet.

Technologies/Languages used:

• JavaScript
• Node.js
• Inquirer
• Jest
• HTML/CSS
• Chalk

Testing

This application utilizes Jest to run unit tests. To run the test:

npm test

Screenshot of rendered file

Walkthrough Demo

demo.mp4

License

MIT