Giter Club home page Giter Club logo

team-profile-generator's Introduction

Team Profile Generator

Generate a professional team profile webpage by using this command-line application. The application prompts the user for information about the team manager, engineers, and interns, and then generates an HTML file that displays a summary of each team member.

Overview

The Team Profile Generator is a command-line application that streamlines the process of creating a well-structured team profile webpage. It is particularly useful for managers and project leads who want to quickly showcase the members of their team with minimal effort.

Features

  • Add team members, including managers, engineers, and interns.
  • Collect information such as name, employee ID, email, and role-specific details.
  • Generate a clean and professional HTML webpage displaying team member profiles.

Getting Started

Prerequisites

  • Node.js installed
  • Inquirer npm package

Installation

  1. Clone the repository
    git clone https://github.com/jay1194/team-profile-generator.git
  2. Install
    npm install

Usage

  1. Open a terminal and navigate to the project directory.
  2. Run the application
    node index.js
  3. Answer the prompts to add team members. Example:
  • Add Manager

    Name: John Doe

    Employee ID: 001

    Email: [email protected]

    Office Number: 123

  • Add Engineer

    Name: Jane Smith

    Employee ID: 002

    Email: [email protected]

    GitHub Username: janesmith

  • Add Intern

    Name: Bob Johnson

    Employee ID: 003

    Email: [email protected]

    School: University of Example

  1. Once all team members are added, the application will generate an HTML file in the output directory.

Demo

Untitled_.Nov.24.2023.2_12.AM.webm

Technologies Used

  • Node.js
  • Inquirer npm package
  • Jest for testing
  • Constructors
  • Test-Driven Development (TDD)
  • Object-Oriented Programming (OOP)

Contributing

  • Contributions are welcome! Feel free to open issues or submit pull requests.

License

badge
This application is covered by the MIT license.

team-profile-generator's People

Watchers

Jayden Taylor avatar

team-profile-generator's Issues

Manager Class extends from Employee

In addition to Employee's properties and methods, Manager will also have:

  • officeNumber

  • getRole()

  • For validation ensure the user input provided is in proper expected format (for testing!)

Intern will extend from Employee

In addition to Employee's properties and methods, Intern will also have:

  • school

  • getSchool()

  • getRole // Overriden to return 'Intern'

  • Add validation to ensure the user input provided is in proper expected format (for testing)

Create template

  • Create a template literal for the answers from inquirer
  • generate a html page
  • Style it using bootstrap
  • Email and username or GitHub must be clickable

Engineer will extend Employee

In addition to Employee's properties and methods, Engineer will also have:

  • github // GitHub username

  • getGithub()

  • getRole // Overriden to return 'Engineer'

  • Add validation to ensure the user input provided is in proper expected format (for testing)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.