Team-Profile-Generator

Description

This project is a Test-Driven Development: Team Profile Generator designed to streamline the process of creating a team's profile. It employs object-oriented programming principles and interactive command-line prompts to collect information about team members and generate an HTML file for easy visualization. The primary technologies and tools used in this project include: JavaScript (JS), Node.js, Inquirer.js and Jest.

Table of Contents

• User Story
• Installation
• Screenshots
• Usage
• Credits
• Deployment
• How to Contribute
  • Contributions
  • Starred Project
• Tests
• Questions
• License
• Badges

User Story

As A developer,
I WANT a tool to generate a team profile,
SO THAT I can easily organize and view information about my team members.

Installation

Users can install the project by cloning the repository from GitHub and follow these steps to install the required dependencies:

1. Initialize the project:

npm init -y

2. Install Inquirer for user prompts:

npm i [email protected]

3. Install Jest for testing:

npm i jest

4. Update test script in package.json: Edit the "test" script in the package.json file (line 10) to use Jest

"test": "jest"

5. Run tests:

npm run test

6. Create .gitignore file: Create a file named .gitignore to specify files and directories that should be ignored by Git. Add the following line to ignore the node_modules folder:

node_modules

Screenshots

The screenshot illustrate the command-line interaction with the Team Profile Generator application.

This screenshot showcases the HTML output of the application, enhanced with added styling for a visually appealing presentation.

Usage

To use the Team Profile Generator, run the command node index.js in the terminal. Follow the prompts to provide information about your team, and the generator will create the team.html file based on your input.

1. Run the application:

node index.js

If you need you can:

1. Stop the application:

^C

2. Clear the terminal:

clear

Credits

• npm Inquirer.js
• Jestjs.io
• Professional README Guide
• Badges Documentation by Shields.io

Deployment

This project is deployed and accessible at the following URLs:

• GitHub Repository: Visit the repository for project details, including a comprehensive README.
• Sample HTML: Visit this link to view the team.html file generated using the application.

How to Contribute

To contribute to this project, follow these steps:

1. Fork the repository.
2. Create a new branch for your feature (git checkout -b feature-name).
3. Commit your changes (git commit -m 'Add feature').
4. Push to the branch (git push origin feature-name).
5. Create a new pull request.

Contributions

This project was developed by a single contributor dePonte.

Starred Project

⭐ Your support by clicking on the star icon located at the top right of the project page and adding it to your favourites list would be greatly appreciated!

Tests

To run Jest tests, execute the following command in the terminal:

npm run test

The screenshot captures the output of the npm run test command for the Team Profile Generator project.

Questions

For any questions or concerns about the project, you can reach me at GitHub: dePonte.

License

Copyright © 2024 dePonte

Badges