This application is built using Node.js and npm inquirer pkg that takes in information(from the terminal) about employees on a software engineering team and generates an HTML webpage that displays summaries for each person. This app is written entirely in Javascript, using Bootstrap and template literals that will render and create a sophisticated Team Profile page in a html format.
- Description
- Table of Contents
- Installation
- Usage
- License
- How to Contribute
- Tests
- Questions
- Walkthrough Demonstration
- Mockup
To install this application, you will need to clone the repo and install the inquirer module by entering npm install inquirer into the command-line.
If you want to learn more about the inquirer pkg, click here.
This app runs directly through the command-line by entering node index.js or node followed by the main filename. You will be given a variety of prompts that will create a webpage with the data you entered in the terminal. The stylized exmaple.html file will appear in the root directory after the user chooses 'No my team is finished.'
This project is licensed under MIT license.
When creating an open source project on GitHub, there is always the option for other developers to contribute to your projects. | If you would like to contribute, please contact me at the email listed below.
There are written tests that validate the object classes and constructor methods within the Employee.js, Manager.js, Engineer.js and Intern.js files. These test are run by using the npm Jest package; Open the terminal and make sure you are running these in the ./test directory, then enter: npm run test.
If you want to learn more about the Jest testing pkg, click here.
Please reach out with any questions you may have about this application.
GitHub: @lindsey-lansford- ✉️ Email: [email protected]
Here is an example screenshot of a page generated by the application.
