Skip to content

💻 A Command Line Application for a manager to generate an HTML website with their team data.

Notifications You must be signed in to change notification settings

jessicablank/team-profile-generator

Repository files navigation

Team Profile Generator

License: MIT GitHub Last Commit

Description:

A Command Line Interface Application developed as homework for coding bootcamp. The tests were provided and the assignment was to build a CLI application that passed the tests and created a stylized HTML file. You can see from the YouTube Video Guide: https://youtu.be/uHwMRGr__9I that I was just beginning to understand the power of Node.Js.

Table of Contents:

Installation Instructions

Fork, Clone, or Download and then install dependencies:

npm install

Open the terminal to run tests:

npm run test

Run the Interface:

npm start

Usage

📺 YouTube Video Guide: https://youtu.be/uHwMRGr__9I

Generated_HTML

  • Start the project in your terminal by entering npm start and follow the prompts to enter team member data.
  • Once you indicate there are no more team members to enter, the application will generate a static HTML page with the team member data.
  • If you run the application again, the previous data will overwrite the team.html file! If you want to save your work, be sure to copy the entire output folder into another folder so the style.css and html background picture will persist.

Tests

There are pre-coded tests utilizing npm jest built into the application. Simply type npm run test into the terminal to see those tests. Other tests include:

  • WHEN the user starts the program,
  • THEN manager information is requested including an office phone.
  • WHEN the user selects to enter engineer data,
  • THEN user is prompted to enter information excluding a phone number but including a GitHub username.
  • WHEN the user selects to enter intern data, THEN the user is prompted to enter information excluding a phone number or GitHub account, but including a school name.
  • WHEN the user selects no more employees to enter,
  • THEN the application renders a stylized HTML file presenting cards with team member data.

File Tree

├── app.js
├── lib
|  ├── Employee.js
|  ├── Engineer.js
|  ├── htmlRenderer.js
|  ├── Intern.js
|  └── Manager.js
├── output
|  ├── index.html
|  ├── style.css
|  └── TNG.jpg
├── package-lock.json
├── package.json
├── README.md
├── templates
|  ├── engineer.html
|  ├── intern.html
|  ├── main.html
|  └── manager.html
└── test
   ├── Employee.test.js
   ├── Engineer.test.js
   ├── Intern.test.js
   └── Manager.test.js

Questions

You can reach the author, Jessica Blankemeier, via jessicablankemeier@gmail.com

License

Copyright 2020 - present Jessica Blankemeier. This project is licensed under the terms of the MIT license. More information is available at opensource.org/licenses

About

💻 A Command Line Application for a manager to generate an HTML website with their team data.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published