/Team_Profile_Generator

Primary LanguageJavaScript

Team Profile Generator The MIT License

Table of Contents:

  1. Authors
  2. Links
  3. Screenshots
  4. Description
  5. Technologies
  6. Installation
  7. Usage
  8. Contribution
  9. Testing
  10. Questions
  11. License

Authors:

Michael Bee

Links:

GitHub Repository: https://github.com/Michael-Bee/Team_Profile_Generator

Deployed Sample HTML: https://michael-bee.github.io/Team_Profile_Generator/

Screenshot:

Team Profile Generator Screenshot

Team Profile Generator Demo:

Watch the Team Profile Generator Demo

Description:

A Node.js command-line application that takes in information about employees on a software engineering team, then generates an HTML webpage that displays summaries for each person.

Technologies:

  • HTML
  • CSS
  • Bootstrap
  • Javascript
  • Node.js

Installation:

  1. Clone the remote repository from GitHub
  2. Install dependencies: nmp install
  3. initiate program: node index

Usage:

  • Answer questions regarding each team member
  • Once HTML is generated, navigate to the dist folder
  • Open output.html in web browser

Contribution:

  1. Fork the repository on GitHub
  2. Create your feature branch: git checkout -b my-new-feature
  3. Commit your changes: git commit -am 'Add some feature'
  4. Push to the branch: git push origin my-new-feature
  5. Submit a pull request on GitHub

Testing:

npm test

Questions:

Email: Bee.Michael.02@gmail.com

GitHub: https://github.com/Michael-Bee

Please contact with any questions.

License:

The MIT License

https://opensource.org/licenses/MIT

Copyright (c) [2022] [Michael Bee]

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.