Create Dynamic Team Profiles

Table of Contents

1. Introduction
2. Module 10 Team Profile Generator
3. Installation and Setup
4. Usage Instructions
5. Testing the Application
6. CSS Design
7. Example Output
8. Dependencies
9. License
10. User Story
11. Acceptance Criteria

Module 10 Team Profile Generator

The Module 10 Team Profile Generator is a command-line application that allows users to generate a web page displaying basic information about their team members. This application is useful for managers who want quick access to their team's email addresses and GitHub portfolios.

Installation and Setup

To install and set up the Module 10 Team Profile Generator, follow these steps:

1. Clone the repository to your desktop.
2. Navigate to the top level of the directory.
3. Open the index.js file.
4. Use the command line to run the application using the command node index.js.

Usage Instructions

Once the application is set up and running, follow these instructions to use it:

1. Enter the name of the team manager.
2. Enter the email address of the manager.
3. Enter the office number of the manager.
4. Choose the type of employee you want to add (engineer or intern).
5. Enter the name, employee ID, and email address of the employee.
6. If needed, provide additional information (e.g., GitHub username for engineers or school name for interns).
7. Repeat steps 4-6 to add more employees.
8. Press Enter to generate the team profile in HTML format.
9. Check the index.html file in the test folder to view the generated profile.

Testing the Application

The Module 10 Team Profile Generator has been tested to ensure functionality and accuracy. To run the automated tests, use the command npm run test.

CSS Design

The generated team profile page uses CSS styling to enhance its visual appearance. The design includes the following elements:

• Navigation bar (navbar)
• Header with a background color
• Cards for each team member
• Styling for card headers, text, links, and icons
• Box shadow effect

Example Output

Here is an example of the generated HTML code for a team profile:

<!-- HTML code here -->

Dependencies

The Module 10 Team Profile Generator relies on the following dependencies:

• JavaScript
• HTML
• CSS
• jQuery

Additionally, the application requires the installation of the following packages via npm:

• Inquirer (for prompt and question functionality)
• fs (for file reading and writing)

License

This project is licensed under the MIT license. For more information, please refer to the LICENSE file.

User Story

As a manager, I want to generate a web page that displays my team's basic information so that I can have quick access to their email addresses and GitHub portfolios.

Acceptance Criteria

The acceptance criteria for the Module 10 Team Profile Generator are as follows:

• The application should prompt the user for information about the team manager and the team members.
• The generated HTML should accurately display the information provided.
• Each team member should have a separate card displaying their name, role, and contact information.
• The manager's card should also display their office number.
• GitHub usernames should be displayed as links.
• The application should be fully tested and error-free.