The Vehicle Builder CLI is an interactive command-line application designed to provide a fun and user-friendly experience for building vehicles. Powered by Node.js and the Inquirer package, this application guides you through a series of prompts, offering two main paths to explore:
-
Select a Pre-Made Vehicle: Browse through a list of pre-configured vehicles. Each option is thoughtfully crafted to provide a variety of models and configurations.
-
Create Your Own Vehicle: Unleash your creativity! Customize your vehicle by choosing from a range of features such as type, color, engine options, and more. Tailor the vehicle to your preferences step by step.
Whether you’re looking for inspiration or want to design your dream vehicle from scratch, this CLI tool ensures a seamless and enjoyable experience. Built with TypeScript and JavaScript, it offers robust functionality and type safety, making it a reliable tool for any user.
To use the Vehicle Builder CLI, follow these steps:
-
Ensure Node.js and npm are installed:
- Download and install Node.js from the official website.
- Verify installation by running the following commands in your terminal:
node -v npm -v
-
Clone the repository:
git clone <repository-url> cd <repository-directory>
-
Install dependencies:
- Run the following command to install the required packages, including Inquirer:
npm install
- Run the following command to install the required packages, including Inquirer:
-
Run the application:
- Start the CLI tool by executing:
npm start
- Start the CLI tool by executing:
Now you’re ready to explore and build vehicles with this interactive tool!
To interact with the Vehicle Builder CLI program, follow these steps:
Use the arrow keys on your keyboard to navigate through the options presented in the prompts.
Press the Enter key to select your desired option from the menu.
If prompted for custom input (e.g., naming your vehicle), type your response directly into the terminal and press Enter to confirm.
When building your own vehicle, follow the guided prompts to choose attributes such as vehicle type, color, engine specifications, and additional features. Use the arrow keys and Enter key to finalize your choices.
At the end of the process, review your selection. The application will provide a summary of the pre-made or custom vehicle you have built.
Contributions are welcome and greatly appreciated! Follow these steps to contribute to the project:
-
Fork the repository:
- Click the "Fork" button on the repository’s GitHub page to create a copy under your own account.
-
Clone your fork:
git clone <your-forked-repository-url> cd <repository-directory>
-
Create a new branch:
git checkout -b <branch-name>
-
Make your changes:
- Implement your desired changes or improvements to the code.
-
Test your changes:
- Ensure your changes work as expected and do not introduce any new issues.
-
Commit your changes:
git add . git commit -m "Description of your changes"
-
Push to your fork:
git push origin <branch-name>
-
Create a Pull Request:
- Navigate to the original repository and click
New Pull Request. - Select your branch and provide a detailed description of your changes.
- Navigate to the original repository and click
Your contributions will be reviewed, and feedback will be provided as necessary. Once approved, your changes will be merged into the main project. Thank you for helping make this project better!
There are currently no test instructions for this program. This application does not include automated tests or testing scripts. Users are encouraged to manually verify functionality by running the application and interacting with the CLI. If you would like to contribute tests to this project, feel free to follow the contributing guidelines above and submit a pull request with your additions.
This project is licensed under the MIT license. Click here for more information.
If you have any questions, please feel free to contact me on GitHub at nathangreen1632.