/employee-summary

Build a team roster via command line interface and then display the results in a neatly formatted HTML file

Primary LanguageJavaScript

employee-summary

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 emails and GitHub profiles

Business Context

This app allows you to build a team roster via command line, and then have the output saved to a nicely styled html page. Input basic information about your emplyee roster and the final output will be saved in your "Templates" directory as an html file (main.html). Use this file wherever you see fit...i.e. it can be implemented in your company's existing website as a static page or behind a firewall for internal use only.

Technology

This app takes advantage of Node's built-in fs library that reads and writes data to and from a file. The app uses a series of html templates based on employee role to pull the entire roster template together (main.html).

Catch a glimpse of the app here:

employee-summary

Installation

  1. Fork the respository
  2. Use git clone from the CLI to clone the remote repository
  3. Update/Modify the project as you see fit
    1. use git to save versions
    2. push your own commit to your repository

To use

  1. To start the application run "node app" from the terminal
  2. As user/manager, you will be prompted for your name and email
  3. From here, you are prompted to build your team, starting with the team member's name and email. Additional information is requested per user role - this will differ across roles.
  4. To end the program, type "no" or "n" when prompted to enter another member. This will end the program and then generate an output html file titled "main.html". You this file at your descretion.