Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bryceberczik/vehicle-builder
https://github.com/bryceberczik/vehicle-builder
Last synced: 4 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/bryceberczik/vehicle-builder
- Owner: bryceberczik
- License: mit
- Created: 2024-08-04T23:19:45.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2024-08-07T23:42:13.000Z (3 months ago)
- Last Synced: 2024-08-08T02:12:46.669Z (3 months ago)
- Language: TypeScript
- Size: 689 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Vehicle-Builder
[](https://opensource.org/licenses/MIT)
## Description
Vehicle Builder is a back-end application that allows you to create and perform certain actions maintaining a sense of logic in the app. You can create a vehicle, with the option for a car, truck and moterbike. You will also have 3 premade vehicles at your disposal that can be used my selecting preexisting vehicles. You can drive the vehicles, go faster and slower, as well as perform wheelies and tow other vehicles as well.
## Table of Contents
- [Installation](#installation)
- [Usage](#usage)
- [License](#license)
- [Contributing](#contributing)
- [Tests](#tests)
- [Questions](#questions)
## Installation
In order to use this application you must ensure that your machine has node.js as well as perform the correct lines of code to get the app working.
## Usage
In order to run the application, you must right click on the index.ts and run the intergrated terminal. From there you can run a, "npm install" or for short just a, "npm i". Once you have installed the packages you can run the following line of code, "npm run start". From there you can use the application to your liking.
https://github.com/user-attachments/assets/5e0800f0-2ce9-48ae-8064-8f4d6ff877a9
## License
This project is licensed under the [MIT](https://opensource.org/licenses/MIT) license.
## Contributing
Contributions are welcome! If you have suggestions for improvements or new features, please create an issue or submit a pull request. For major changes, please open an issue first to discuss what you would like to change. Thank you!
## Tests
The package.json file has 3 scripts, a build that will transpile the typescript into javascript for a better readability, a start command that will perform a build as well as run the application, and finally a test that looks for errors but will just echo the following line, "Error: no test specified".
## Questions
If you have any questions, you can reach me at [[email protected]](mailto:[email protected]). You can also find more of my work at [bryceberczik](https://github.com/bryceberczik) on Github.