squad-profile-generator

Squad Profile Generator

Description

I leveraged Node.js to create a command-line application that utilizes Jest for unit testing and Inquirer for user input. This application efficiently gathers information about team members in software engineering. Upon user input, it dynamically generates an HTML webpage showcasing summaries for each team member, complete with their emails and GitHub profiles. Execution is seamless with the simple command ‘node index.js,’ ensuring smooth operation and alignment with user story requirements.”

Demo

squad-profile-generator.webm

Screenshots

• 
• 

Features

• User Input Handling: Collects information from the user in a structured manner using inquirer prompts, facilitating interaction with the programme.

• Dynamic HTML Generation: Constructs HTML content dynamically based on user input, providing a visual representation of the team members.

• Object-Oriented Programming (OOP): utilises classes and objects to encapsulate data and behaviours, promoting code organisation and reusability.

• Asynchronous Control Flow: Utilises promises and asynchronous functions to manage the flow of operations, enhancing responsiveness and efficiency.

• Modularization: Separates functionalities into different modules and files, promoting code organisation, maintainability, and reusability.

• File System Interaction: Interacts with the file system to create directories and write generated HTML content to a file, facilitating data persistence and output.

Table of Contents

• Demo
• Screenshots
• Features
• Installation
• Usage
• License
• List of Third Party Assets
• Contributing
• Tests
• Questions

Installation

1. Clone the repository

2. Run this command in your Terminal to install dependencies.

   • npm install or npm i

Usage

1. Navigate to the project directory

2. Run this command in your Terminal to generate the output HTML

   • node index.js

• Click on the link to view the Squad Profile Generator

License

The Squad profile generator operates under license. For licencing details, click here: MIT License.

List of third-party assets.

• Node.js version @6.5.0
• Inquirer.js
• jest
• fontawesome
• Bootstrap

Contributing

Contributors are welcome to fork repo, enhance code, and commit changes. Create PR, adhere to licence terms, provide a clear description, and collaborate responsibly

Tests

• Run Jest tests with this command

  • npm run test

Questions

Contact me here for any questions @francis-gomes-esq or email me figomesokoye@protonmail.com

---

© 2024 Francis Gomes-Okoye.

This site is open source. Improve this page.