https://github.com/fleetbase/starter-extension
Starting point for a new Fleetbase Extension, clone or use CLI to scaffold a new bare bones extension.
https://github.com/fleetbase/starter-extension
Last synced: about 1 year ago
JSON representation
Starting point for a new Fleetbase Extension, clone or use CLI to scaffold a new bare bones extension.
- Host: GitHub
- URL: https://github.com/fleetbase/starter-extension
- Owner: fleetbase
- License: agpl-3.0
- Created: 2024-08-05T07:58:57.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-10-10T12:04:53.000Z (over 1 year ago)
- Last Synced: 2025-04-12T14:09:32.919Z (about 1 year ago)
- Language: JavaScript
- Size: 453 KB
- Stars: 1
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
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:
```bash
composer require fleetbase/core-api
composer require fleetbase/starter-api
```
### Frontend
Install the Ember.js Engine/Addon:
```bash
pnpm install @fleetbase/starter-engine
```
## Usage
### Backend
🧹 Keep a modern codebase with **PHP CS Fixer**:
```bash
composer lint
```
⚗️ Run static analysis using **PHPStan**:
```bash
composer test:types
```
✅ Run unit tests using **PEST**
```bash
composer test:unit
```
🚀 Run the entire test suite:
```bash
composer test
```
### Frontend
🧹 Keep a modern codebase with **ESLint**:
```bash
pnpm lint
```
✅ Run unit tests using **Ember/QUnit**
```bash
pnpm test
pnpm test:ember
pnpm test:ember-compatibility
```
🚀 Start the Ember Addon/Engine
```bash
pnpm start
```
🔨 Build the Ember Addon/Engine
```bash
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.