Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/williamcrownover/team-profile-generator

A Node.js command line program that uses inquirer to collect team member data and then generates an HTML page displaying the entire team.
https://github.com/williamcrownover/team-profile-generator

command-line-tool html inquirer jest nodejs test-driven-development

Last synced: about 1 month ago
JSON representation

A Node.js command line program that uses inquirer to collect team member data and then generates an HTML page displaying the entire team.

Host: GitHub
URL: https://github.com/williamcrownover/team-profile-generator
Owner: WilliamCrownover
License: mit
Created: 2021-07-15T06:45:34.000Z (over 3 years ago)
Default Branch: main
Last Pushed: 2021-08-29T02:31:03.000Z (over 3 years ago)
Last Synced: 2023-07-31T08:50:06.653Z (over 1 year ago)
Topics: command-line-tool, html, inquirer, jest, nodejs, test-driven-development
Language: JavaScript
Homepage:
Size: 157 KB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# Team Profile Generator

[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

## Description

This is a Node.js based application built for team managers who would like to quickly generate a team profile HTML webpage that is organized into data cards per employee for quick reference. Running the app through a terminal allows the user to enter data for a manager and then an infinite number of engineers or interns until they are ready to output the index.html and accompanying style.css files. Using a responsive design, data cards are pushed to the index.html for each team member. Engineers include a link to their GitHub profiles while interns list the school they are enrolled in. Every employee includes their email available to click and load to the user’s email software of choice.

An important element I explored as part of this app is the testing modules included in the __tests__ folder. Each of the four classes built into the app have a suit of tests run using ‘jest’ to confirm proper object creation and method call functionality. Also included is the ‘inquirer’ module with validation for properly entered answers to the command line questions. Examples include checking that each name is not blank and does not include numbers along with making sure the emails include the @ symbol.

## Table of Contents

- [User Story](#user-story)
- [Walkthrough Video](#walkthrough-video)
- [Example Generated HTML Webpage](#example-generated-html-webpage)
- [Installation](#installation)
- [Usage](#usage)
- [Tests](#tests)
- [Technologies](#technologies)
- [License](#license)
- [Contact](#contact)

## User Story
```
AS A manager
I WANT to generate a webpage that displays my team's basic info
SO THAT I have quick access to their emails and GitHub profiles
```

## Walkthrough Video

https://www.youtube.com/watch?v=AtOq2hcFxUg&ab_channel=WilliamCrownover

## Example Generated HTML Webpage

Example of generated team profile webpage

https://drive.google.com/file/d/1hipiAClXWToMrqqvo1sXyjSBqbFqUZ9e/view?usp=sharing

## Installation

You will need Node.js installed on your local machine to run this app.
Then you can clone this repo to your local machine.
You can then run it in VSCode and open an integrated terminal of the root folder.
Before use, run `npm install` to load any dependencies such as Inquirer to the folder.

## Usage

After proper installation, the app can be run using `node index.js` in the command line.
You will first be asked for the team manager’s information.
After that you can add infinite numbers of engineers and interns by filling out requested information per team member.
When ready to generate the file you will select ‘Finished’ for the next team member and the webpage html and css files will be generated to the “dist” folder.

## Tests

This application has four sets of tests for the class objects. To run the tests in VSCode, install 'jest' to dev dependencies with `npm install jest -D` and then use `npm run test` in an integrated terminal.

## Technologies
- Node.js
- Inquirer
- Jest

## License
Licensed under the MIT License - https://opensource.org/licenses/MIT

## Contact

If you have any questions you can email me at [email protected].

You can also check out my other work on GitHub at [WilliamCrownover](https://github.com/WilliamCrownover)