ProcessMaker Developers Documentation
processmaker.comKnowledge CenterProcessMaker University
Guides
Guides
  • Getting Started
    • Installing ProcessMaker
  • Authentication
    • Creating a Client Application
    • Getting an Access Token
    • Getting a Refresh Token
  • Working with the API
    • Starting a Request via REST API
    • Starting a Request via Web Hook
  • Embedding Forms
    • Starting a Request via Anonymous Web Entry
    • Participating in a Workflow via Intermediate Web Entry (Anonymous)
    • Participating in a workflow via Intermediate Web Entry (Authenticated)
    • Angular Inbox Tutorial
      • Part 0: Overview
      • Part 1: Hello World
      • Part 2: Services & Dependencies
      • Part 3: Components
      • Part 4: The Inbox
      • Part 5: The Screen & Form Elements
  • Script Task Examples
    • PHP
  • Packages
    • ProcessMaker Platform Packages
      • Actions By Email Package
      • Advanced Screens Package
      • Advanced User Package
      • Auth Package
      • C# Package
      • Collections Package
      • Comments Package
      • Conversational Forms Package
      • Data Connector Package
      • Decision Tables Package
      • Documentation Package
      • DocuSign Package
      • Dynamic UI Package
      • File Manager Package
      • Google Places Package
      • IDP Package
      • Java Package
      • PDF Generator Package
      • PM Blocks Package
      • Process Optimization Package
      • Python Package
      • R Package
      • Saved Searches Package
      • Send Email Package
      • Signature Package
      • Slack Notification Package
      • Translations Package
      • Versioning Package
      • Vocabularies Package
      • Web Entry Package
    • Custom Packages
      • The Package Skeleton
      • Creating Your First ProcessMaker Package
Powered by GitBook
On this page
  • Overview
  • Step 1: Getting Started
  • Clone the repo
  • Set Package Name
  • Step 2: Install Composer
  • Composer
  • Node Modules
  • Installation
  • Step 3: Navigation and testing
  • Uninstall
  1. Packages
  2. Custom Packages

The Package Skeleton

The Skeleton Package is a template to get started with ProcessMaker Platform Packages

PreviousCustom PackagesNextCreating Your First ProcessMaker Package

Last updated 1 year ago

Overview

The skeleton package provides the necessary base to start developing a package for ProcessMaker Platform. Because ProcessMaker is built with , this is essentially a skeleton package for Laravel, with some modifications to ease development within the ProcessMaker Platform.

Step 1: Getting Started

Clone the repo

git clone https://github.com/Processmaker/package-skeleton.git

Set Package Name

Change the package name (default is package skeleton) throughout the package to whatever name you would like:

cd package-skeleton
php rename-project.php string_to_replace

Step 2: Install Composer

Composer

Make sure composer and any dependencies are installed correctly:

composer update && composer install

Node Modules

npm install && npm run dev

Installation

In order to install your package in ProcessMaker, here are the step-by-step instructions.

Don't forget to replace the name you changes above when executing the commands below. They use the default name of package-skeleton but should be replaced with what you changed the name to.

Require the Package

Require the package with Composer and thereby adding it to the composer.json file as a dependency of the application:

composer require processmaker/package-skeleton --ignore-platform-reqs

Run the installation command

php artisan package-skeleton:install

Step 3: Navigation and testing

  • Navigate to the admin menu in your ProcessMaker Platform instance.

  • You should see your new menu item "Package Skeleton" or whatever you named your package, in the left sidebar.

Uninstall

Note: it is up to the developer to add any necessary code or proceedures to the install and uninstall commands. These can include adding and removing tables in the database, setting or removing api keys etc

  • Use php artisan package-skeleton:uninstall to uninstall the package.

  • Use composer remove processmaker/package-skeleton to remove the package completely.

​

The installation code is located within Laravels artisan console commands. You can find additional details about it here:

Laravel
Artisan Docs