malloryfaria / team-profile-generator

a Node.js command-line application that takes in information about employees on a software engineering team and generates an HTML webpage that displays summaries for each person.

Home Page:https://youtu.be/ItXS4mn2ufc

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Team Profile Generator

GitHub license

Table of Contents



Description

A Node.js command-line application that takes in information about employees on a software engineering team and generates an HTML webpage that displays summaries for each person.

Installation

To install all the dependencies, use the command below:

npm i

Usage

As a manager of a team, you would enjoy using this application to generate a webpage that displays your team's basic information so that you can quickly access their emails and GitHub profiles

To use this application, clone the repository to your local machine:

git clone git@github.com:malloryfaria/team-profile-generator.git

Then, ensure you install the dependencies with command:

npm i

When you're ready to run the application, from the root folder, type the below into your command line:

node index

Once the application runs, it will generate an index.html file in the "dist" folder. If you already have an index.html file in that folder, it will first prompt you to overwrite it or not.

Demo

Click the image below for a video demonstration of the application and the generated index.html file at the end:

Team Profile Generator Demo

Click the image below for a video demonstration of the tests passing:

Team Profile Test Passing Demo

Deployed application link

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

Languages

JavaScript, Bootstrap, Google Fonts, Material Icons, HTML, Node, Inquirer, Jest

Screenshot

What the command line interface looks like:

Team Profile Generator Command Line

What the tests passing looks like:

Team Profile Generator Tests Command Line

What the index.html file looks like once complete: Sample Index.HTML

License

This project is licensed under the MIT license.

Contributing

If you'd like to contact me, feel free to reach out using the Questions section below. This was a module 10 homework assignment for the UofT Coding Bootcamp.

Tests

To run the tests for this application, enter the following command from the root directory:

npm run test



Questions?

If you have any questions about the project, contact me at: mallory.faria@gmail.com
Check out the rest of my work at: malloryfaria

About

a Node.js command-line application that takes in information about employees on a software engineering team and generates an HTML webpage that displays summaries for each person.

https://youtu.be/ItXS4mn2ufc

License:MIT License


Languages

Language:JavaScript 77.0%Language:HTML 20.5%Language:CSS 2.5%