License

MIT License

The above copyright badge and this permission notice shall be included in all copies or substantial portions of the Software. This product is covered by the MIT license.

Team Profile Gen

Description

Welcome to the Team Profile Gen README.

The Team Profile Generator is a command-line tool for creating a webpage showcasing your development team. You can add details for each member, including managers, engineers, and interns. The application generates an HTML page displaying your team's structure, with each member's vital information.

Table of Contents

• Description
• Installation
• Usage
• License
• Contributing
• Tests
• Questions

Installation

1. Clone the repository: git clone https://github.com/your-username/your-repo.git
2. Navigate to the repository: cd your-repo
3. Install the dependencies: npm install
4. Run the application: node index.js

Usage

1. Adding a Manager: Start the application using node index.js. Provide details for the manager when prompted.
2. Adding an Engineer: Choose "Add an engineer" from the menu. Enter the engineer's details - name, ID, email, and GitHub username.
3. Adding an Intern: Choose "Add an intern" from the menu. Enter the intern's details - name, ID, email, and school.
4. Finish Building the Team: Select "Finish building the team" when done. The HTML file will be generated and saved.
5. View the Team Profile: Open the generated HTML file in your browser to see your team's profile with all the details neatly arranged.

Note: Ensure you have Node.js and npm installed before starting. Adjust file and folder names as needed in your code.

Contributing

If you wish to contribute to the Team Profile Generator, follow these guidelines:

1. Clone this repository: git clone https://github.com/your-username/your-repo.git
2. Create a new branch: git checkout -b your-feature-branch
3. Commit your changes: git commit -m "Your contribution message"
4. Push to your branch: git push origin your-feature-branch
5. Create a pull request: Submit your changes for review.

Engage in discussions with the maintainers and wait for feedback. Once your contribution is accepted, you'll be part of the project team.

Tests

1. Install the dependencies: npm install
2. Navigate to the project directory: cd TeamProfileGen
3. Run the tests: npm test

Ensure all tests pass without errors. Review the test logs and address any issues. Once all tests pass, share your results through the GitHub repository.

Questions

If you have any questions regarding the project, you can reach the maintainer at haxmo25@gmail.com or visit the GitHub profile at hpro97.