cvf/pallet-api

Inventory & Warehouse Management Extension for Fleetbase

dev-main 2024-06-11 03:12 UTC

Requires

• php: ^7.4|^8.0
• cvf/core-api: dev-main
• cvf/fleetops-api: dev-main
• 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

MIT

README

Inventory & Warehouse Management Extension for Fleetbase

Overview

This monorepo contains both the frontend and backend components of the Pallet extension for Fleetbase. The frontend is built using Ember.js and the backend is implemented in PHP.

Requirements

• PHP 7.3.0 or above
• Ember.js v3.24 or above
• Ember CLI v3.24 or above
• Node.js v14 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/fleetops
composer require fleetbase/pallet

Frontend

Install the Ember.js Engine/Addon:

pnpm install @fleetbase/pallet

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.