Team Profile Generator

Table of Contents

1. About The Project
   • Built With
2. Installation
3. Usage
4. Testing
5. Contributing
6. Contact
7. License

About The Project

This profile generator is a CLI that produces an HTML page based on the user's inputs.

Built With

• NodeJS
• NPM

Installation

Clone the repository. Then in the terminal, navigate to your local copy of the repository and use the command 'npm install'. This will install all of the necessary packages. Once completed use the command 'npm index' to start the app.

Here is a link to a video demo of the installation and use of the app.

Usage

This generator could be used anytime an organization wants to quickly build a profile page for their team or project.

Testing

Once the app's dependencies are installed, using the command 'node run test' will execute all tests. Any additional tests should be stored in the directory 'tests/'.

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

Contact

Brendan Francis - B.Francis@SprengerV.com

Project Link: https://github.com/SprengerV/team_profile_generator

License

BSD 3-Clause License

Copyright (c) 2021, Brendan Francis All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. © 2021 GitHub, Inc.