/Teamplate

A Node.js command-line application for managers to generate HTML team profiles.

Primary LanguageJavaScriptMIT LicenseMIT

Teamplate

Licence

Description

A software engineering team generator command line application. The application prompts the user for information about the team manager and then information about the team members. The user can input any number of team members, and they may be a mix of engineers and interns. This application is also coded to pass all unit tests. When the user has completed building the team, the application will create an HTML file that displays a nicely formatted team roster based on the information provided by the user.

Links

Github repo url: https://github.com/Kane-R/Teamplate

Deployed url: https://kane-r.github.io/Teamplate/

Table of Contents

Installation

To install Teamplate, clone or download this entire repository.

Usage

  • See mp4 video of the application being run here: https://github.com/Kane-R/Teamplate/blob/master/test/Test_13-05-2020.mp4
  • To run this application and generate a teamPage.html file, type "node app.js" in your terminal
  • First ensure you are in the correct directory in your terminal. The correct directory will contain app.js (look for "// This is the app.js file you need to run to generate your teamPage.html..." at the top of app.js)

NOTE: Before running this application for the first time on your local machine, it's likely or possible you'll need to install:

  • The file-system npm package (Enter "npm install file-system --save" in the application’s root directory);
  • The inquirer npm package (Enter "npm install inquirer" in the application’s root directory)
  • The jest npm package (Enter "npm install --save-dev jest" in the application’s root directory)

Licence

The MIT Licence

Contributing

Please get in touch with me via email if you'd like to contribute.

Tests

Testing is conducted using the jest npm package (run test by entering "npm run test" in the terminal)

See below screen capture gif of a recent test:

Questions

Contact: Kane Robinson Email: Kane@KanesTrades.com