Skip to content

Latest commit

 

History

History
270 lines (176 loc) · 7.15 KB

README.md

File metadata and controls

270 lines (176 loc) · 7.15 KB
Raw

Template repository for EspoCRM extensions

Create a repository for your extension from this template.

Preparing repository

Run:

php init.php

It will ask to enter an extension name and some other information.

After that, you can remove init.php file from your repository. Commit changes and proceed to configuration & building.

Configuration

Create config.json file in the root directory. You can copy config-default.json and rename it to config.json.

When reading, this config will be merged with config-default.json. You can override default parameters in the created config.

Parameters:

  • espocrm.repository - from what repository to fetch EspoCRM;
  • espocrm.branch - what branch to fetch (stable is set by default); you can specify version number instead (e.g. 5.9.2);
  • database - credentials of the dev database;
  • install.siteUrl - site url of the dev instance;
  • install.defaultOwner - a webserver owner (important to be set right);
  • install.defaultGroup - a webserver group (important to be set right).

Config for EspoCRM instance

You can override EspoCRM config. Create config.php in the root directory of the repository. This file will be applied after EspoCRM installation (when building).

Example:

<?php
return [
    'useCacheInDeveloperMode' => true,
];

Building

After building, EspoCRM instance with installed extension will be available at site directory. You will be able to access it with credentials:

  • Username: admin
  • Password: 1

Preparation

  1. You need to have node, npm, composer installed.
  2. Run npm install.
  3. Create a database. Note that without the created database instance building will fail. The database name is set in the config file. You can change it.

Full EspoCRM instance building

It will download EspoCRM (from the repository specified in the config), then build and install it. Then it will install the extension.

Command:

node build --all

Note: It will remove a previously installed EspoCRM instance, but keep the database intact.

Note: If an error occurred, check site/data/logs/ for details. It's often a database is not created.

Copying extension files to EspoCRM instance

You need to run this command every time you make changes in src directory and you want to try these changes on Espo instance.

Command:

node build --copy

You can set up a file watcher in your IDE to avoid running this command manually. See below about the file watcher.

Running after-install script

AfterInstall.php will be applied for EspoCRM instance.

Command:

node build --after-install

Extension package building

Command:

node build --extension

The package will be created in build directory.

Note: The version number is taken from package.json.

Installing addition extensions

If your extension requires other extensions, there is a way to install them automatically while building the instance.

Necessary steps:

  1. Add the current EspoCRM version to the config.php:
<?php
return [
    'version' => '6.2.0',
];
  1. Create the extensions directory in the root directory of your repository.
  2. Put needed extensions (e.g. my-extension-1.0.0.zip) in this directory.

Extensions will be installed automatically after running the command node build --all or node build --install.

Development workflow

  1. Do development in src dir.
  2. Run node build --copy.
  3. Test changes in EspoCRM instance at site dir.

Using entity manager to create entities

You can block out new entity types right in Espo (using Entity Manager) and then copy generated custom files (site/custom dir) to the repository (src dir) using copy-custom.js script.

  1. Create entity types, fields, layouts, relationships in Espo (it should be available in site dir after building).
  2. Run node copy-custom.js. It will copy all files from site/custom to src/files/custom/Espo/Modules/{ModuleName} and apply needed modifications to files.
  3. Remove files from site/custom.
  4. Run node build --copy. It will copy files from the repository to Espo build (site/custom//Espo/Modules/{ModuleName} dir).
  5. Clear cache in Espo.
  6. Test in Espo.
  7. Commit changes.

You can remove copy-custom.js from the repository if you don't plan to use it future.

Using composer in extension

If your extension requires additional libraries, they can be installed by composer:

  1. Create a file src/files/custom/Espo/Modules/{ModuleName}/composer.json with your dependencies.
  2. Once you run node build --all or node build --composer-install, composer dependencies will be automatically installed.
  3. Create a file src/files/custom/Espo/Modules/{ModuleName}/Resources/autoload.json.

Note: The extension build will contain only the vendor directory without the composer.json file.

The autoload.json file defines paths for namespaces:

{
    "psr-4": {
        "LibraryNamespace\\": "custom/Espo/Modules/{ModuleName}/vendor/<vendor-name>/<library-name>/path/to/src"
    }
}

Versioning

The version number is stored in package.json and package-lock.json.

Bumping version:

npm version patch
npm version minor
npm version major

Tests

Unit

Run composer install:

`(cd site; composer install)`

Command to run unit tests:

node build --copy; site/vendor/bin/phpunit site/tests/unit/Espo/Modules/{@name}

Integration

You need to build a test instance first:

  1. node build --copy
  2. (cd site; grunt test)

You need to create a config file tests/integration/config.php:

<?php

return [
    'database' => [
        'driver' => 'pdo_mysql',
        'host' => 'localhost',
        'charset' => 'utf8mb4',
        'dbname' => 'TEST_DB_NAME',
        'user' => 'YOUR_DB_USER',
        'password' => 'YOUR_DB_PASSWORD',
    ],
];

The file should exist before you run node build --copy.

Command to run integration tests:

(cd site && vendor/bin/phpunit tests/integration/Espo/Modules/{@name})

Configuring IDE

You need to set the following paths to be ignored in your IDE:

  • build
  • site/build
  • site/custom/
  • site/client/custom/
  • site/tests/unit/Espo/Modules/{@name}
  • site/tests/integration/Espo/Modules/{@name}

File watcher

You can set up a file watcher in the IDE to automatically copy and transpile files upon saving.

File watcher parameters for PhpStorm:

  • Program: node
  • Arguments: build --copy-file --file=$FilePathRelativeToProjectRoot$
  • Working Directory: $ProjectFileDir$

Using ES modules

As of v8.0.

The initialization script asks whether you want to use ES6 modules. If you choose "NO", you still can switch to ES6 later:

  1. Set bundled to true in extension.json.
  2. Set bundled and jsTranspiled to true in src/files/custom/Espo/Modules/{@name}/Resources/module.json.
  3. Add src/files/custom/Espo/Modules/{@name}/Resources/metadata/app/client.json 
    {
    "scriptList": [
        "__APPEND__",
        "client/custom/modules/{@nameHyphen}/lib/init.js"
    ]
}

License

Change a license in LICENSE file. The current license is intended for scripts of this repository. It's not supposed to be used for code of your extension.