npm.io
0.1.9 • Published 3 months ago

@fleetbase/registry-bridge-engine

Licence
AGPL-3.0-or-later
Version
0.1.9
Deps
15
Size
484 kB
Vulns
0
Weekly
0
Stars
3

Internal Bridge between Fleetbase API and Extensions Registry


Overview

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

  • 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/registry-bridge
Frontend

Install the Ember.js Engine/Addon:

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