Skip to content

Latest commit

 

History

History
99 lines (64 loc) · 3.8 KB

README.md

File metadata and controls

99 lines (64 loc) · 3.8 KB

Team profile generator

License

About

This CLI node.js application generates an HTML file that displays essential information about a software engineering team's employees, such as their emails and GitHub profiles. Team generator prompts the user with Inquirer to provide details about the employees.

Application is passing all the provided tests.

Table of Contents

  1. Installation
  2. Usage
  3. Tests
  4. Tools
  5. Credits
  6. Contributing

Installation

To use this application, fork the repository and clone it to your local environment with:

git clone git@github.com:<user>/team-profile-generator.git

Then install necessary dependencies with:

npm i

Usage

The application can be invoked in the root directory of the application with the following command:

node index.js

You will then be prompted for all the information about the project.

Full preview video available here

Your generated file will use pre-existing template:

preview

Tests

Application utilises Jest for perfoming tests. Testing done with:

npm test

tests-passing

Tools

html  CSS3  Bootstrap  JavaScript  NodeJS  npm  jest 

Credits

Contributing

Contributions are always welcome!

Contributor Covenant

Creating A Pull Request

  • Fork the project
  • Create your feature branch (git checkout -b feature/newfeature)
  • Commit your changes (git commit -m 'Add feature')
  • Push to the branch (git push origin feature/newfeature)
  • Open a Pull Request

Image of github-profile-views-counter

Copyright © 2023 :octocat:@alexandrabatrak


This README was generated with ❤️ by readme-generator