fleetbase/storefront-api

Headless Commerce & Marketplace Extension for Fleetbase

0.3.7 2024-04-02 09:30 UTC

Requires

• php: ^8.0
• fleetbase/core-api: ^1.4.16
• fleetbase/fleetops-api: ^0.4.24
• geocoder-php/google-maps-places-provider: ^1.4
• laravel-notification-channels/apn: ^5.0
• laravel-notification-channels/fcm: ^4.1
• laravel-notification-channels/twilio: ^3.3
• milon/barcode: ^10.0
• php-http/guzzle7-adapter: ^1.0
• psr/http-factory-implementation: *
• stripe/stripe-php: 13.13.0
• toin0u/geocoder-laravel: ^4.4

Requires (Dev)

• friendsofphp/php-cs-fixer: ^3.34.1
• nunomaduro/collision: ^7.0
• pestphp/pest: ^2.33.2
• phpstan/phpstan: ^1.10.38
• symfony/var-dumper: ^5.4.29

MIT

• Fleetbase Pte Ltd.
• Ronald A. Richardson

• e-commerce
• marketplace
• storefront
• headless commerce
• fleetbase-extension

README

Open-source Headless Commerce & Marketplace Extension for Fleetbase

Overview

This monorepo contains both the frontend and backend components of the Storefront 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 v4.8 or above
• Ember CLI v4.8 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/fleetops-api
composer require fleetbase/storefront-api

Frontend

Install the Ember.js Engine/Addon:

pnpm install @fleetbase/storefront-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.