The Employee Template Engine is a Node CLI application that allows a user to input information about his/her engineering team and then generate a HTML page containing the team's information. The app was created to help management quickly view information about their team. The app prompts the user to enter information about the manager and then allows the user to enter an infinite amount of team members which may be in an engineering role or an intern role. Specific questions are asked based on the role of the employee. Once the user has entered all the team members, the app generates a styled HTML page which the user can open in their browser and view what's been entered. Employee Template Engine was written in Javascript using Node.js.
Installation
Usage
Tests
Contributing
Questions
License
To run Employee Template Engine, you must install Node.js on your computer.
Once Node.js is installed on your computer, open up your terminal and go to the directory that Employee Template Engine is located. Run the command "node index.js". Once the app is started you will be prompted to enter information about the manager. It will ask for the manager's name, id, email, and office number and then it will ask if you would like to enter another team member. If you select yes, it will ask what role the team member has, Engineer or Intern. The app will then ask for the team member's name, id, email and will ask for the team member's GitHub username if they are an Engineer or for the team member's school if they are an intern. Once the information is completed, it will ask again if you would like to add another team member. If your answer is no, the app will return a message that the employee template was succesfully created. Navigate to the directory that the app is in and go to the output folder to find the team.html file. Open the file in your browser to see your generated team page.
To test the app, install jest from node package manager. The test files will be located in test directory. To run the tests, run the command "node run test". Tests that pass will be highlighted in green. Tests that fail will be highlighted in red.
To contribute, fork the repository and clone the repo to your computer. Make changes locally and push to your branch and then submit a pull request.
Visit my GitHub Profile
For additional questions, contact me by email at raiford87@gmail.com.
MIT License
Copyright (c) 2020 Rashawn Raiford
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.