Skip to content

Latest commit

 

History

History
89 lines (53 loc) · 2.28 KB

README.md

File metadata and controls

89 lines (53 loc) · 2.28 KB

README - TEAM PROFILE GENERATOR

License: MIT

Link to see the deployed application:

YouTube video

Description

This is a node.js that generates an html with contact cards for employees of a specific team on a business by using a command-line application from a user's input using the Inquirer package.

This app has been tested using the Jest Testing Framework

Table of contents:

  1. Installation
  2. Usage
  3. License
  4. Contributing
  5. Test
  6. Questions

Installation

  1. Fork repository
  2. Clone repository to local environment.
  3. Node.js must be installed.
  4. To install all the dependencies (Inquirer, Jest to perform tests) use the following command:
npm install

Usage

The application is invoked by using the following command (on the directory containing this project):

node index.js

The following questions will be prompted asking for the Manager details, followed by a list of options to select to input the details of Engineer and Intern or to generate the html:

Manager Questions

Engineer questions:

Engineer Questions

Intern questions:

Intern Questions

HTML will be generated on 'dist' folder under the name 'employee.html':

dist folder

Mockup for the generated html:

employees.html

License

This project is covered under the MIT license.

Contributing

When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change. Please note we have a code of conduct, please follow it in all your interactions with the project. Contributions follow the Contributor Convenant.

Test

100% test coverage on classes using Jest package.

To run test:

npm run test

test

Questions

GitHub profile

Contact Me - Email