Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

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

Module 12 Challenge for EDX Bootcamp
https://github.com/richllew182/team-profile-generator

Last synced: about 2 months ago
JSON representation

Module 12 Challenge for EDX Bootcamp

Awesome Lists containing this project

README 

        
# Team Profile Generator

Module 12 Challenge for EDX Bootcamp



  Table of Contents

  
    

        
  1. 

          Description

          

        
    2. 

        
  2. 

            Installation

        
    3. 

        
  3. Usage
    4. 

        
  4. Testing
    5. 

        
  5. License
    6. 

        
  6. Contact
    7. 

        
  7. Acknowledgments
    8. 

      



## Description





    Team Profile Generator Screenshot

  






 
This was the 12th homework challenge for the EDX Bootcamp in Front End Development.
 



   
Our task was to take some starter code and convert it into a working Node.js command-line application.

 



 
The application takes in information about employees on a software engineering team, and then generates a html webpage that displays summaries for each team member.

 



### Built With



* ![Node.js](https://img.shields.io/badge/Node.js-43853D?style=for-the-badge&logo=node.js&logoColor=white)

* ![JavaScript](https://img.shields.io/badge/JavaScript-323330?style=for-the-badge&logo=javascript&logoColor=F7DF1E)

* ![Jest](https://img.shields.io/badge/Jest-323330?style=for-the-badge&logo=Jest&logoColor=white)

* ![HTML](https://img.shields.io/badge/HTML-239120?style=for-the-badge&logo=html5&logoColor=white)

* ![Bootstrap](https://img.shields.io/badge/bootstrap-%238511FA.svg?style=for-the-badge&logo=bootstrap&logoColor=white)

* ![CSS](https://img.shields.io/badge/CSS-239120?&style=for-the-badge&logo=css3&logoColor=white)



## Installation



  To install this app, please open the folder in a new integrated terminal and then type the following:

~~~sh

npm i

~~~



## Usage



To use this project, please first clone the repository to your local machine.



To run the project, open the folder in your integrated terminal, and run the following command:



~~~sh

node index.js

~~~



You will be prompted in the terminal to input your details as a Manager of the team, such as Name, ID, Email and Office Number. Some of these fields are validated to only accept certain characters or valid inputs.



The app will give you 3 choices:



* Add an Engineer

* Add an Intern

* Finish Building Team.



If you choose either Engineer or Intern you will then be asked to input the details of the relevant team member, such as Name, ID, email, and then either GitHub username for Engineer or School Name for Intern. When you have finished adding all the details you will be taken back to the menu, and from there you can either add more team members or finish building your team.



Once you have finished building your team a HTML document will be generated in the output folder. You can view your newly genereated team by opening this file in your default browser.



## Testing



This app uses Jest to test that the code is functioning as expected. To run these tests, open the folder in a new integrated terminal and run the following:

~~~sh

npm run test

~~~



## License



Distributed under the MIT License. See `LICENSE.txt` for more information.



## Contact



Richard Llewellyn - [email protected] 



Project Repo Link: [https://github.com/RichLlew182/team-profile-generator](https://github.com/RichLlew182/team-profile-generator)



Sample HTML Link: [https://github.com/RichLlew182/team-profile-generator/blob/main/output/team.html](https://github.com/RichLlew182/team-profile-generator/blob/main/output/team.html)



## Acknowledgments



* [Img Shields](https://shields.io)

* [Best README Template](https://github.com/othneildrew/Best-README-Template)