fleetbase / vroom-api
VROOM route optimization machine extension for Fleetbase
Installs: 3
Dependents: 0
Suggesters: 0
Security: 0
Stars: 0
Watchers: 0
Forks: 0
Open Issues: 0
Language:JavaScript
Requires
- php: ^8.0
- fleetbase/core-api: *
- php-http/guzzle7-adapter: ^1.0
- psr/http-factory-implementation: *
Requires (Dev)
- friendsofphp/php-cs-fixer: ^3.34.1
- nunomaduro/collision: ^5.11.0|^6.4.0
- pestphp/pest: ^1.22.6
- phpstan/phpstan: ^1.10.38
- symfony/var-dumper: ^5.4.29
README
Starter Extension for Fleetbase
Overview
This monorepo contains both the frontend and backend components for a Skeleton/Starter extension for Fleetbase. The frontend is built using Ember.js and the backend is implemented in PHP.
- PHP 8.2 or above
- Ember.js v5.4 or above
- Ember CLI v5.4 or above
- Node.js v18 or above
Structure
├── addon
├── app
├── assets
├── translations
├── config
├── node_modules
├── server
│ ├── config
│ ├── data
│ ├── migrations
│ ├── resources
│ ├── src
│ ├── tests
│ └── vendor
├── tests
├── testem.js
├── index.js
├── package.json
├── phpstan.neon.dist
├── phpunit.xml.dist
├── pnpm-lock.yaml
├── ember-cli-build.js
├── composer.json
├── CONTRIBUTING.md
├── LICENSE.md
├── README.md
Installation
Backend
Install the PHP packages using Composer:
composer require fleetbase/core-api composer require fleetbase/starter-api
Frontend
Install the Ember.js Engine/Addon:
pnpm install @fleetbase/starter-engine
Usage
Backend
🧹 Keep a modern codebase with PHP CS Fixer:
composer lint
⚗️ Run static analysis using PHPStan:
composer test:types
✅ Run unit tests using PEST
composer test:unit
🚀 Run the entire test suite:
composer test
Frontend
🧹 Keep a modern codebase with ESLint:
pnpm lint
✅ Run unit tests using Ember/QUnit
pnpm test
pnpm test:ember
pnpm test:ember-compatibility
🚀 Start the Ember Addon/Engine
pnpm start
🔨 Build the Ember Addon/Engine
pnpm build
Contributing
See the Contributing Guide for details on how to contribute to this project.
License
This project is licensed under the MIT License.