Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/samantha-ruth/team-profile-generator

Create a page of employees' information and roles. Created using node, npm inquirer, and javascript.
https://github.com/samantha-ruth/team-profile-generator

css3 html5 inquirerjs javascript nodejs npm

Last synced: about 2 months ago
JSON representation

Create a page of employees' information and roles. Created using node, npm inquirer, and javascript.

Awesome Lists containing this project

README 

        
# Team-Profile-Generator



## Description



This project was an activity to link together node, npm inquirer, and the javascript testing framework "jest" as well as using constructors, classes, and Object Oriented Development.  The goal of this project was to automatically generate website populated with employees entered by the user from the command line.   



This project helped me understand how the concept of Object Oriented Development and running tests to ensure the code will work correctly. I learned how to install Jest and make sure it is one of the developmental dependencies in the node_modules.  I also learned how to create constructors and class objects and methods.  I learned how to refactor the code, making multiple, easier to read files instead of one long coding file and how to create an extention class that uses inheritance to pass properties onto other objects.  I reinforced how to use the node file system to write new files and copy o thers. I also learned how to destructure arrays and objects to create variables from object properties. 



## Table of Contents



* [Installation](#installation)

* [Usage](#usage)

* [Links](#links)

* [Questions](#questions)



## Installation



If the user already has node installed on their device, they can download this project and run "npm init" and then "npm install" to download the dependencies.  If they are interested in running the tests, enter "npm i --save-dev jest".  Next, the user should enter "node index.js" into their command line to start the user prompts.



## Usage



The user will receive a series of prompts, asking for members of their team.  It will start out with the manager, and then ask whether or not the user would like to enter other employees, either an engineer or an intern.  The user can enter as many engineers and interns as they would like for their team.  



When the user is finished entering their information, an html file is created with "My Team" on top, and then a listing of the members of the team, their role, their ID, their email, and their office number, gitHub username, and school based on whether they are managers, engineers, or interns, respectively.  When the user clicks on an email, an autopopulated email server pops up.  When they click on a gitHub address, they are taken to that gitHub user's homepage.  



Unfortunately, I have not yet created the link between the objects and the create page function.  I am still working on it! So sorry. 



![Image of Prompt Screen](https://user-images.githubusercontent.com/64170123/175839620-3471a490-c559-4d3a-a634-446e7d4d558b.jpg)



![Image of html screen](https://user-images.githubusercontent.com/64170123/175839531-bd67df5d-4957-4967-8e30-7879f279c615.jpg)



## Links



link to video of tests: https://drive.google.com/file/d/1nKCxbWm18uSKE947XxkB7CZBlH1g-K3P/view

link to video of command line prompts: https://drive.google.com/file/d/13xj8Nfie1BrWg-LqWOw_tJuvRVys9fHr/view



Link to video of project: 



The link to the project is here: https://samantha-ruth.github.io/Team-Profile-Generator/



The url of the Git repository is here: https://github.com/Samantha-Ruth/Team-Profile-Generator



## Questions



If you have any questions about the repo, open an issue or you can find more of my work at (https://gitHub.com/Samantha-Ruth).