https://github.com/blindsweatyhansolo/teamprofilegen
CLI App for generating a custom team-profile HTML page, based on user-inputted data.
https://github.com/blindsweatyhansolo/teamprofilegen
bootstrap css html5 inquirer javascript jest nodejs
Last synced: 3 months ago
JSON representation
CLI App for generating a custom team-profile HTML page, based on user-inputted data.
- Host: GitHub
- URL: https://github.com/blindsweatyhansolo/teamprofilegen
- Owner: blindsweatyhansolo
- Created: 2022-04-21T15:56:43.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2022-05-01T19:56:12.000Z (about 4 years ago)
- Last Synced: 2025-01-06T06:43:47.984Z (over 1 year ago)
- Topics: bootstrap, css, html5, inquirer, javascript, jest, nodejs
- Language: JavaScript
- Homepage:
- Size: 10.2 MB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Team Profile Generator
## Table of Contents
* [Description](#description)
* [Installation](#installation)
* [Demo](#demo)
* [Tests](#tests)
* [Technologies](#technologies)
* [Contributions](#contributions)
* [Additional Information](#additional-information)
## [Description:](#table-of-contents)
Team Profile Generator is a simple command-line interface application that dynamically creates a custom HTML page for you and your team members, displaying summaries for each team member based on inputs provided by the user.
*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 their emails and GitHub profiles
```
## [Installation:](#table-of-contents)
To install the required dependencies, run the following command:
```
npm i inquirer
```
To install Jest for testing
```
npm i jest
```
## [Demo:](#table-of-contents)
[Project Walkthrough Demo Video](https://drive.google.com/file/d/1jUdBlt5DOIS7ihSTSWko-ARN3h_ybAuz/view?usp=sharing)
This application runs from the command line. After installing the required dependencies, run using the following command:
```
node index.js
```
Once all members have been added, check the 'dist' folder for the index.html file for your team page! The HTML file CSS created via Bootstrap (already linked for your convenience).
## [Tests:](#table-of-contents)
Testing completed using the [Jest JavaScript Testing Framework](https://jestjs.io/)
## [Technologies:](#table-of-contents)
Created using:
* Node.js
* Inquirer Package from NPM
* HTML and BootStrap
## [Contributions:](#table-of-contents)
No contributors currently, but contributions more than welcome. If you are interested please contact me using the info [below](#additional-information)
## [Additional Information:](#table-of-contents)
_If you have any questions about the application, have any notes, or would like to become a contributor, please feel free to contact me._
[GitHub](https://github.com/blindsweatyhansolo)