EspoCRM extension template for easier development.
It is recommended to use it with espo-docker-dev which supplies containerized espocrm environment.
See setup extensions in espo-docker-dev for more information.
To intialize the extension do the following steps:
- clone the template:
git clone https://github.com/superewald/espo-ext-template your-extension
- initialize the template:
cd your-extension && ./init.sh
composer install
npm install
./build.sh
The script will generate a zip file in the root directory ready to be deployed.
This template uses a cleaned up directory structure compared to the official espocrm extension template. Instead of alot of nested folders the template uses the following directory mapping:
template | original | description |
---|---|---|
app/ |
files/application/Espo/Modules/<ModuleName> |
application files (php and json) |
client/ |
files/client/modules/<module-name> |
client files (JS/CSS/LESS/HTML) |
scripts/ |
scripts/ |
extension hooks (for (un)install) |
The build script creates the needed directory structure for the extension zip file.