Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/iitoneloc/team-generator

Last synced: 15 days ago
JSON representation

Host: GitHub
URL: https://github.com/iitoneloc/team-generator
Owner: iiTONELOC
License: mit
Created: 2021-02-20T18:44:30.000Z (almost 4 years ago)
Default Branch: main
Last Pushed: 2021-02-23T22:25:57.000Z (almost 4 years ago)
Last Synced: 2023-02-28T22:22:37.224Z (almost 2 years ago)
Language: JavaScript
Size: 9.94 MB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        
# Team Profile Generator  

[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) ![GitHub language count](https://img.shields.io/github/languages/count/iiTONELOC/team-generator?style=flat-square) ![GitHub top language](https://img.shields.io/github/languages/top/iiTONELOC/team-generator?style=flat-square)

# Screenshot

![Team Profile Generator](./images/screenshot.png)

# Description

Team Profile Generator is a Node.js application that dynamically generates an HTML porfolio that contains email and gitHub information for team members.

# Table of Contents

*[Demo](#demo)  

*[Technology](#technology)  

*[Features](#features)  

*[Installation](#installation)  

*[Usage](#usage)  

*[Contribute](#contribute)  

*[Tests](#tests)  

*[Questions](#questions)  

*[License](#license)

# Demo

[DEMO: Team Profile Generator](https://drive.google.com/file/d/1IAt_96EQxS67WplW8dt5P4T0NnFw8-we/view)

# Technology 

| Technology | Description                        |Links ↘️ |

| ---------- | -----------------------------------| ------|  

| ![JavaScript](https://shields.io/static/v1?label=JavaScript&message=98.7%&color=yellow&style=flat-square) | ES6+ | [Jest](https://jestjs.io/) |

| ![HTML](https://shields.io/static/v1?label=HTML&message=0%&color=orange&style=flat-square) | Hyper Text Markup Language | [Font Awesome](https://fontawesome.com/) |

| ![CSS](https://shields.io/static/v1?label=CSS&message=1.3%&color=rebeccapurple&style=flat-square) | Cascading Style Sheets  | [Bootstrap](https://getbootstrap.com/) |

# Features

This app features the Inquirer package for user prompts and jest for TDD.

# Installation  

Project Repository: [Team Profile Generator](https://github.com/iiTONELOC/team-generator)  

Clone the repo, the link is above. Navigate to the root of the directory of the project.   Then type the following command to load the required modules: ```npm install```  Once the modules have finished loading type: ```node index``` 

# Usage

[Team Profile Generator](https://github.com/iitoneloc/team-generator)  

Follow the prompts and enter in the information. You can add as many or as little team members as necessary. 

# Contribute 

If you wish to contribute, fork the repo and issue a pull request for changes.

# Tests

Tests are built in, if you wish to run the tests in the modules from the root of the directory type: ```npm run test```   If you wish you add your own tests be sure to include them in the __tests__ folder.

# Questions

Feel free to reach out if you have any questions

Contact via GitHub: [iiTONELOC](https://github.com/iiTONELOC)  

Send an email: [[email protected]](mailto:[email protected])

# License

MIT License

        Copyright (c) 2021 Anthony Tropeano

        

        Permission is hereby granted, free of charge, to any person obtaining a copy

        of this software and associated documentation files (the "Software"), to deal

        in the Software without restriction, including without limitation the rights

        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell

        copies of the Software, and to permit persons to whom the Software is

        furnished to do so, subject to the following conditions:

        

        The above copyright notice and this permission notice shall be included in all

        copies or substantial portions of the Software.

        

        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR

        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,

        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE

        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER

        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,

        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE

        SOFTWARE.