a Node.js command-line application that takes in information about employees on a software engineering team and generates an HTML webpage that displays summaries for each person.
- Description
- Screenshot
- Installation
- Usage
- Video Walk Through
- Technology
- Features
- Credits
- License
- Contribution Guidelines
- Feedback
- Socials
The purpose of this application is to create a command-line application that can take in user inputs and use those inputs to generate A team profile HTML page.
The application has a number of features which include:
- Accepting user inputs
- When all the user inputs have been accepted then a completed team-page is rendered in the dist/ directory
- When the GitHub username is clicked, their profile is opened up in a new tab
- The default email program is opened when the email address of the employee is selected
- All employees can have the following data input and rendered:
- name
- employee ID
- email address
- path to stored img of employee
- Managers can have their office number input and rendered
- Engineers can have their github username input and rendered
- Interns can have their school input and rendered
AS A manager I WANT to generate a webpage that displays my team's basic info SO THAT I have quick access to their emails and GitHub profiles
Probably the most important aspect of this project was learning how to use the principles of OOP(object orientated programming). Specifically how to use classes correctly.
Other things I learned:
- Furthered my knowledge of inquirer
- Learned how to implement the principles of Test Driven Development by using Jest
- Learned more about how to structure my applications
In order to install this note taker app and test it you need to follow these steps.
-
Ensure that you have node and npm installed
-
For detailed instructions on installing node please follow this link for instructions
-
Clone this repository into your local repository.
git clone git@github.com:TheInfamousGrim/team-profile-generator.git.
-
Install the dependencies
npm install
If you've followed these steps correctly then the application should be good to go and can be tested using software like Insomnia Core 😁
Please follow these steps to use the application
-
Run the following script from your terminal
npm run start
The technology used for the development of this app was:
dev-dependencies:
dependencies:
- Uses express.js to create and run a server
- Updates a JSON file when creating and deleting notes
- Has a functional API
- Deployed to heroku
🙏 Made with the help of:
I'm open to have anyone jump in and contribute just message me on twitter
Please follow the contribution guidelines! Guidelines for contributing
Any feedback please email George Fincher
GitHub: TheInfamousGrim
