Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

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

Command-line team profile page generator.
https://github.com/katiechurchwell/team-profile-generator

jest nodejs

Last synced: 3 days ago
JSON representation

Command-line team profile page generator.

Host: GitHub
URL: https://github.com/katiechurchwell/team-profile-generator
Owner: katiechurchwell
Created: 2022-01-16T02:57:13.000Z (almost 3 years ago)
Default Branch: main
Last Pushed: 2022-02-14T23:29:20.000Z (over 2 years ago)
Last Synced: 2024-10-12T12:14:34.669Z (about 1 month ago)
Topics: jest, nodejs
Language: JavaScript
Homepage:
Size: 1.32 MB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

        # Team Profile Generator

  [![project-languages-used](https://img.shields.io/github/languages/count/katiechurchwell/team-profile-generator?color=important)](https://github.com/katiechurchwell/team-profile-generator)

  [![project-top-language](https://img.shields.io/github/languages/top/katiechurchwell/team-profile-generator?color=blueviolet)](https://github.com/katiechurchwell/team-profile-generator)

## Summary

![HTML5](https://img.shields.io/badge/html5-%23E34F26.svg?style=flat&logo=html5&logoColor=white) ![CSS3](https://img.shields.io/badge/css3-%231572B6.svg?style=flat&logo=css3&logoColor=white) ![Jest](https://img.shields.io/badge/-jest-%23C21325?style=flat&logo=jest&logoColor=white) ![NodeJS](https://img.shields.io/badge/node.js-6DA55F?style=flat&logo=node.js&logoColor=white)

Command-line application that takes in information about employees and generates an HTML webpage that displays summaries for each person. Built with Node.js, [Inquirer.js](https://github.com/SBoudrias/Inquirer.js) and tested with [Jest](https://jestjs.io/).

## Demo

### Initializing program:

!["Demo of initializing and using the program"](/images/terminal-demo.gif)

### Navigating to generated profile page:

!["Demo of locating the generated profile page"](/images/file-location.gif)

### Example of Team Profile:

!["Example profile page"](/images/page-example.png)

### Passing Jest Tests: :tada:

!["Passing Jest tests -- yahoo!"](/images/jest-tests.gif)

## Installation

Clone the respository to your machine. Initialize NPM (`npm init -y`) before running.

## Usage

Type `node.index` into the command line to initialize program. Fill out the on-screen prompts. Once finished, navigate to the `output` folder for your new README.md file.

## Questions

  If you have any questions about this project, please open an issue or use the contact information below:

  * [katiechurchwell](https://www.github.com/katiechurchwell)

  * [[email protected]](mailto:[email protected])

---

  ![](https://img.shields.io/badge/license-MIT-blue)