- About
- Technology Stack
- Installation:
- Setting Up the Project
- Using the Application
- License:
- Collaborators:
- Video:
- Questions:
This Node.js command-line application is a comprehensive solution designed for software engineering teams to manage and display employee information efficiently. The project's completion has resulted in a robust application that takes in specific details of team members and generates a well-organized HTML webpage.
Each team member's summary is presented in a clear and concise manner, allowing for quick and easy access to individual profiles. Throughout the development process, a test-driven development (TDD) approach was adopted to ensure the maintainability and reliability of the codebase. Every functional component of the application has been meticulously tested, with all units passing their respective tests, signifying the high quality and stability of the application.
As the application is designed for internal use and does not require deployment, its functionality and the successful results of the testing process have been demonstrated in a walkthrough video. This video serves as both a visual guide to the application's features and a testament to its seamless operation and effectiveness.
Node.js is an essential part of our development environment. Depending on your operating system, the installation steps differ. Below are the instructions for both macOS and Windows.
We recommend installing Node.js via Homebrew, which is a package manager for macOS. Here's how you can do it:
Visit the official Homebrew website and follow the installation instructions. At the time of this guide, the installation command is:
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)
Copy and paste this command into your macOS Terminal.
Once Homebrew is installed, enter the following command to install Node.js and NPM (Node Package Manager):
Copy code
brew install node
Confirm that Node.js is installed successfully by checking its version:
Copy code
node -v
You should see the installed version of Node.js displayed in the terminal.
The installation process on Windows involves using the official Node.js installer.
Go to the Node.js Downloads page. Click on the "Windows Installer" to download the latest default version. As of this guide, the latest LTS version is 16.15.0.
Once the download is complete, execute the installer and follow the prompts to install Node.js.
After installation, check that Node.js is installed properly:
Copy code
node -v
Run this command in your Command Prompt, and it should display the Node.js version installed on your system.
By following these instructions, you should have Node.js up and running on your machine, ready for development!
Firstly, you need to clone the repository to your local machine. Choose a directory where you want to store the project. Open your Command Line Interface (CLI) on macOS or Windows and execute the following command:
git clone https://github.com/alex-bahena/Dynamic-team-profile-generator.git
Ensure you are in the directory where you want to clone the repository before running the command.
After cloning, move into the project directory with this command:
cd team-profile-generator/
Within the directory, you need to install the necessary Node packages. Run the following command:
npm install
This will install all required dependencies, including Inquirer and Jest, into a new node_modules/ folder within your project directory.
To launch the application, simply start the index.js file with this command:
node index.js
Initial Steps
When you run the application, you'll be greeted with a welcome message and some brief instructions. Immediately after, you'll start by entering the manager's details.
Adding the Manager
You'll be prompted to answer four questions about the manager:
-
What is the manager's name?
-
What is the manager's employee ID?
-
What is the manager's email address?
-
What is the manager's office number?
Building Your Team
Once the manager's information is set, you can add engineers and interns to your team. After each addition, you'll have the option to continue adding team members or finish.
For Engineers
When adding an engineer, answer the following:
-
What is the engineer's name?
-
What is the engineer's employee ID?
-
What is the engineer's email address?
-
What is the engineer's GitHub username?
For Interns
When adding an intern, provide the following information:
-
What is the intern's name?
-
What is the intern's employee ID?
-
What is the intern's email address?
-
What is the intern's school?
After you've finished building your team or choose to exit the program, a index.html file will be generated in the /dist directory, where you'll find your newly created webpage displaying your team's profiles.
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
Alejandro Bahena.
- Github Profile: https://github.com/alex-bahena
- If you run into any questions, please don't hesitate to contact me: alex.bahena@gmail.com