https://github.com/gaitherdb/team-profile-generator
A command-line application that accepts user input to make a webpage that displays employees and information about them.
https://github.com/gaitherdb/team-profile-generator
classes-and-objects command-line inquirer templateliterals tests
Last synced: 2 months ago
JSON representation
A command-line application that accepts user input to make a webpage that displays employees and information about them.
- Host: GitHub
- URL: https://github.com/gaitherdb/team-profile-generator
- Owner: Gaitherdb
- Created: 2021-08-05T02:12:11.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2021-08-10T21:20:35.000Z (almost 4 years ago)
- Last Synced: 2025-01-31T12:12:57.691Z (4 months ago)
- Topics: classes-and-objects, command-line, inquirer, templateliterals, tests
- Language: JavaScript
- Homepage:
- Size: 99.6 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Team Profile Generator
## 
## Description
A command-line application that accepts user input to make a webpage that displays employees and information about them. This is intended for a software developer company with a manager, engineers and possibly an intern. Having an webpage that neatly organizes this information allows for an easy way to share information about your employees, including name, role, email, or possibly their GitHub profile or the school they attended, depending on the role.
I use Node.js to start the application on the backend, which runs the npm inquirer module to prompt input. The collected information is sorted by different classes. Each class has methods pertaining to the class, and each method and class are tested in the test files. The information is then parsed and passed into HTML format.
As I am new to Node.js, and most of what was used here, I struggled with taking mulitple inquiries and parsing them. It was also tough making sure my test files were reliable.
## Table of Contents
* [Installation](#installation)
* [Usage](#usage)
* [License](#license)
* [Contributing](#contributing)
* [Tests](#tests)
* [Questions](#questions)
## Installation
To install Node.js, run the following command:
```
node i -y
```
To install necessary dependencies, run the following command:
```
npm i
```
## Usage
Set the path to the Team-Profile-Generator folder in the terminal, run the index.js file by typing `node index.js`. Answer each prompt with the specifics for your team and a styled HTML will be generated with the user input.
https://user-images.githubusercontent.com/83731627/128808170-e8759bc3-9aef-440f-b34a-0770dcd5037e.mp4
## License
This project is licensed under the terms of the [MIT License](https://opensource.org/licenses/MIT).
## Contributing
I am the sole author of this repo and I am not currently looking for contributors.
## Tests
Run the command:
```
npm test
```
https://user-images.githubusercontent.com/83731627/128808266-c9f5824a-7c62-4b7e-8543-0096250c8506.mp4
## Questions
If you have any questions about the repo, open an issue or contact me directly at [email protected]. You can find more of my work at [Gaitherdb](https://github.com/Gaitherdb).