Git Product home page Git Product logo

team-profile-generator's Introduction

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 [email protected]

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

team-profile-generator's People

Stargazers

 avatar

Watchers

 avatar

Forkers

schris48 kach9201

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.