Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/mleftwich/teamprofiler

Generates HTML page with profiles of team members from user input in terminal
https://github.com/mleftwich/teamprofiler

html5 javascript jquery nodejs

Last synced: 7 days ago
JSON representation

Generates HTML page with profiles of team members from user input in terminal

Awesome Lists containing this project

README

        

![MIT](https://img.shields.io/static/v1?label=License&message=MIT&color=green)
# Team Profile Generator

## Table of Contents
* [Description](#description)
* [Technologies](#technologies)
* [Installation](#installation)
* [Usage](#usage)
* [Contributing](#contributing)
* [Guidelines](#guidelines)
* [Tests](#tests)
* [License](#license)
* [Questions](#questions)
---

## Description
Application to generate a HTML page based on user input provided in the terminal. Using node.js and the inquirer, and filesystem dependencies user runs the application and receives prompts to enter information about different employees in a team. Upon completion the individual employees are logged in an array and sent to an outputHTML function which renders the information into HTML format with corresponding team member cards. You can see a demonstration of the app in use [here](https://drive.google.com/file/d/1d_rC9T7u5VgOmP0RMNBZq2tVw5yNGSzS/view).

![screenshot](./assets/imgs/screenshot.png)

## Technologies
* HTML
* CSS
* Bootstrap
* JavaScript
* JQuery
* node.js

## Installation
Clone the repository and npm install

## Usage
To use the app open terminal and run index.js

## Contributing
If you'd like to contribute, reach out to me through the email listed below.

## Guidelines
Framework set up to allow for 3 types of employee - managers, engineers, and interns. Reach out if customisation needed.

## Tests
All tests were run using node's Jest. Tests to check all classes functioning correctly.

## License
Licensed under [MIT](https://opensource.org/licenses/MIT)

---

## Questions
For any questions you can find me at [GitHub](https://github.com/mleftwich) or email me at [[email protected]](mailto:[email protected])