cvf/fleetops-api

Fleet & Transport Management Extension for Carvach FleetOps

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

This package is not auto-updated.

Last update: 2024-06-11 10:23:08 UTC


README

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

Requirements

  • PHP 8.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 rohit0814/core-api
composer require rohit0814/fleetops-api

Frontend

Install the Ember.js Engine/Addon:

pnpm install cv-fleetops-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