Initial commit

.gitattributes

@@ -0,0 +1,11 @@
+* text=auto
+*.php text eol=crlf
+*.js text eol=crlf
+*.json text eol=crlf
+*.md text eol=crlf
+*.less text eol=crlf
+*.css text eol=crlf
+*.tpl text eol=crlf
+*.html text eol=crlf
+
+*.png binary

.gitignore

@@ -0,0 +1,7 @@
+/build/
+/site/
+/tests/integration/config.php
+/node_modules
+/config.json
+/config.php
+/extensions/

LICENSE

@@ -0,0 +1,121 @@
+Creative Commons Legal Code
+
+CC0 1.0 Universal
+
+    CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE
+    LEGAL SERVICES. DISTRIBUTION OF THIS DOCUMENT DOES NOT CREATE AN
+    ATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS
+    INFORMATION ON AN "AS-IS" BASIS. CREATIVE COMMONS MAKES NO WARRANTIES
+    REGARDING THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS
+    PROVIDED HEREUNDER, AND DISCLAIMS LIABILITY FOR DAMAGES RESULTING FROM
+    THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED
+    HEREUNDER.
+
+Statement of Purpose
+
+The laws of most jurisdictions throughout the world automatically confer
+exclusive Copyright and Related Rights (defined below) upon the creator
+and subsequent owner(s) (each and all, an "owner") of an original work of
+authorship and/or a database (each, a "Work").
+
+Certain owners wish to permanently relinquish those rights to a Work for
+the purpose of contributing to a commons of creative, cultural and
+scientific works ("Commons") that the public can reliably and without fear
+of later claims of infringement build upon, modify, incorporate in other
+works, reuse and redistribute as freely as possible in any form whatsoever
+and for any purposes, including without limitation commercial purposes.
+These owners may contribute to the Commons to promote the ideal of a free
+culture and the further production of creative, cultural and scientific
+works, or to gain reputation or greater distribution for their Work in
+part through the use and efforts of others.
+
+For these and/or other purposes and motivations, and without any
+expectation of additional consideration or compensation, the person
+associating CC0 with a Work (the "Affirmer"), to the extent that he or she
+is an owner of Copyright and Related Rights in the Work, voluntarily
+elects to apply CC0 to the Work and publicly distribute the Work under its
+terms, with knowledge of his or her Copyright and Related Rights in the
+Work and the meaning and intended legal effect of CC0 on those rights.
+
+1. Copyright and Related Rights. A Work made available under CC0 may be
+protected by copyright and related or neighboring rights ("Copyright and
+Related Rights"). Copyright and Related Rights include, but are not
+limited to, the following:
+
+  i. the right to reproduce, adapt, distribute, perform, display,
+     communicate, and translate a Work;
+ ii. moral rights retained by the original author(s) and/or performer(s);
+iii. publicity and privacy rights pertaining to a person's image or
+     likeness depicted in a Work;
+ iv. rights protecting against unfair competition in regards to a Work,
+     subject to the limitations in paragraph 4(a), below;
+  v. rights protecting the extraction, dissemination, use and reuse of data
+     in a Work;
+ vi. database rights (such as those arising under Directive 96/9/EC of the
+     European Parliament and of the Council of 11 March 1996 on the legal
+     protection of databases, and under any national implementation
+     thereof, including any amended or successor version of such
+     directive); and
+vii. other similar, equivalent or corresponding rights throughout the
+     world based on applicable law or treaty, and any national
+     implementations thereof.
+
+2. Waiver. To the greatest extent permitted by, but not in contravention
+of, applicable law, Affirmer hereby overtly, fully, permanently,
+irrevocably and unconditionally waives, abandons, and surrenders all of
+Affirmer's Copyright and Related Rights and associated claims and causes
+of action, whether now known or unknown (including existing as well as
+future claims and causes of action), in the Work (i) in all territories
+worldwide, (ii) for the maximum duration provided by applicable law or
+treaty (including future time extensions), (iii) in any current or future
+medium and for any number of copies, and (iv) for any purpose whatsoever,
+including without limitation commercial, advertising or promotional
+purposes (the "Waiver"). Affirmer makes the Waiver for the benefit of each
+member of the public at large and to the detriment of Affirmer's heirs and
+successors, fully intending that such Waiver shall not be subject to
+revocation, rescission, cancellation, termination, or any other legal or
+equitable action to disrupt the quiet enjoyment of the Work by the public
+as contemplated by Affirmer's express Statement of Purpose.
+
+3. Public License Fallback. Should any part of the Waiver for any reason
+be judged legally invalid or ineffective under applicable law, then the
+Waiver shall be preserved to the maximum extent permitted taking into
+account Affirmer's express Statement of Purpose. In addition, to the
+extent the Waiver is so judged Affirmer hereby grants to each affected
+person a royalty-free, non transferable, non sublicensable, non exclusive,
+irrevocable and unconditional license to exercise Affirmer's Copyright and
+Related Rights in the Work (i) in all territories worldwide, (ii) for the
+maximum duration provided by applicable law or treaty (including future
+time extensions), (iii) in any current or future medium and for any number
+of copies, and (iv) for any purpose whatsoever, including without
+limitation commercial, advertising or promotional purposes (the
+"License"). The License shall be deemed effective as of the date CC0 was
+applied by Affirmer to the Work. Should any part of the License for any
+reason be judged legally invalid or ineffective under applicable law, such
+partial invalidity or ineffectiveness shall not invalidate the remainder
+of the License, and in such case Affirmer hereby affirms that he or she
+will not (i) exercise any of his or her remaining Copyright and Related
+Rights in the Work or (ii) assert any associated claims and causes of
+action with respect to the Work, in either case contrary to Affirmer's
+express Statement of Purpose.
+
+4. Limitations and Disclaimers.
+
+ a. No trademark or patent rights held by Affirmer are waived, abandoned,
+    surrendered, licensed or otherwise affected by this document.
+ b. Affirmer offers the Work as-is and makes no representations or
+    warranties of any kind concerning the Work, express, implied,
+    statutory or otherwise, including without limitation warranties of
+    title, merchantability, fitness for a particular purpose, non
+    infringement, or the absence of latent or other defects, accuracy, or
+    the present or absence of errors, whether or not discoverable, all to
+    the greatest extent permissible under applicable law.
+ c. Affirmer disclaims responsibility for clearing rights of other persons
+    that may apply to the Work or any use thereof, including without
+    limitation any person's Copyright and Related Rights in the Work.
+    Further, Affirmer disclaims responsibility for obtaining any necessary
+    consents, permissions or other rights required for any use of the
+    Work.
+ d. Affirmer understands and acknowledges that Creative Commons is not a
+    party to this document and has no duty or obligation with respect to
+    this CC0 or use of the Work.

README.md

@@ -0,0 +1,221 @@
+# 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 respository. 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 intallation (when building).
+
+Example:
+
+```php
+<?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. The database name is set in the config file.
+
+### 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.
+
+### 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
+```
+
+### 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
+<?php
+return [
+    'version' => '6.2.0',
+];
+
+```
+
+2. Create the `extensions` directory in the root directory of your repository.
+3. 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.
+
+## Blocking out extension in Espo
+
+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/application/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/application/Espo/Modules/{ModuleName}` dir).
+5. Clear cache in Espo.
+6. Test in Espo.
+7. Commit changes.
+8. Profit.
+
+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 to use additional libraries, they can be installed by the composer:
+
+1. Create a file `src/files/application/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.
+
+Note: the extension build will contain only the `vendor` directory without `composer.json` file.
+
+## 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
+
+Prepare:
+
+1. `node build --copy`
+2. `cd site`
+3. `grunt test`
+
+### Unit
+
+Command to run unit tests:
+
+```
+vendor/bin/phpunit tests/unit/Espo/Modules/{@name}
+```
+
+### Integration
+
+You need to create a config file `tests/integration/config.php`:
+
+```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:
+
+```
+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/application/Espo/Modules/{@name}`
+* `site/tests/unit/Espo/Modules/{@name}`
+* `site/tests/integration/Espo/Modules/{@name}`
+
+## 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.