{"id":19506071,"url":"https://github.com/espocrm/ext-real-estate","last_synced_at":"2025-04-26T02:32:21.332Z","repository":{"id":41641060,"uuid":"264135941","full_name":"espocrm/ext-real-estate","owner":"espocrm","description":"Real Estate extension for EspoCRM","archived":false,"fork":false,"pushed_at":"2025-04-20T13:44:10.000Z","size":901,"stargazers_count":16,"open_issues_count":0,"forks_count":10,"subscribers_count":5,"default_branch":"master","last_synced_at":"2025-04-24T07:11:31.490Z","etag":null,"topics":["crm","espocrm","extension","php","real-estate"],"latest_commit_sha":null,"homepage":"","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/espocrm.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-05-15T08:12:39.000Z","updated_at":"2025-04-20T13:44:07.000Z","dependencies_parsed_at":"2024-03-15T11:43:17.451Z","dependency_job_id":"28da1817-8371-49ae-ae44-35502af25358","html_url":"https://github.com/espocrm/ext-real-estate","commit_stats":null,"previous_names":[],"tags_count":12,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/espocrm%2Fext-real-estate","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/espocrm%2Fext-real-estate/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/espocrm%2Fext-real-estate/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/espocrm%2Fext-real-estate/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/espocrm","download_url":"https://codeload.github.com/espocrm/ext-real-estate/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250922127,"owners_count":21508279,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["crm","espocrm","extension","php","real-estate"],"created_at":"2024-11-10T22:35:32.663Z","updated_at":"2025-04-26T02:32:21.036Z","avatar_url":"https://github.com/espocrm.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Real State extension for EspoCRM\r\n\r\n[See more](https://www.espocrm.com/extensions/real-estate/) on the website.\r\n\r\n## Configuration\r\n\r\nCreate `config.json` file in the root directory. When reading, this config will be merged with `config-default.json`. You can override default parameters in the created config.\r\n\r\nParameters:\r\n\r\n* espocrm.repository - from what repository to fetch EspoCRM;\r\n* espocrm.branch - what branch to fetch (`stable` is set by default); you can specify version number instead (e.g. `5.8.5`);\r\n* database - credentials of the dev database;\r\n* install.siteUrl - site url of the dev instance.\r\n\r\n\r\n## Config for EspoCRM instance\r\n\r\nYou can override EspoCRM config. Create `config.php` in the root directory of the repository. This file will be applied after EspoCRM installation (when building).\r\n\r\nExample:\r\n\r\n```php\r\n\u003c?php\r\nreturn [\r\n    'useCacheInDeveloperMode' =\u003e true,\r\n];\r\n```\r\n\r\n## Building\r\n\r\nAfter building, EspoCRM instance with installed extension will be available at `site` directory. You will be able to access it with credentials:\r\n\r\n* Username: admin\r\n* Password: 1\r\n\r\nNote: You can build on Linux and Windows OS. Commands are the same.\r\n\r\n### Preparation\r\n\r\n1. You need to have *node*, *npm*, *composer* installed.\r\n2. Run `npm install`.\r\n3. Create a database. The database name is set in the config file.\r\n\r\n### Full EspoCRM instance building\r\n\r\nIt will download EspoCRM (from the repository specified in the config), then build and install it. Then it will install the extension.\r\n\r\nCommand:\r\n\r\n```\r\nnode build --all\r\n```\r\n\r\nNote: It will remove a previously installed EspoCRM instance, but keep the database intact.\r\n\r\n### Extension package building\r\n\r\nCommand:\r\n\r\n```\r\nnode build --extension\r\n```\r\n\r\nThe package will be created in `build` directory.\r\n\r\nNote: The version number is taken from `package.json`.\r\n\r\n## Development workflow\r\n\r\n1. Do development in `src` dir.\r\n2. Run `node build --copy`.\r\n3. Test changes in EspoCRM instance at `site` dir by opening it in a browser. A URL will look like: `http://localhost/real-estate/site`, depending on how you named your directory.\r\n\r\n## Tests\r\n\r\nPrepare:\r\n\r\n1. `node build --copy`\r\n2. `cd site`\r\n3. `grunt test`\r\n\r\nUnit tests:\r\n\r\n```\r\nvendor/bin/phpunit --bootstrap=./vendor/autoload.php tests/unit/Espo/Modules/RealEstate\r\n```\r\n\r\nIntegration tests:\r\n\r\n```\r\nvendor/bin/phpunit --bootstrap=./vendor/autoload.php tests/integration/Espo/Modules/RealEstate\r\n```\r\n\r\n## Versioning\r\n\r\nThe version number is stored in `package.json` and `package-lock.json`.\r\n\r\nBumping version:\r\n\r\n```\r\nnpm version patch\r\nnpm version minor\r\nnpm version major\r\n```\r\n\r\n## Translation\r\n\r\nAssuming that you have already built EspoCRM instance.\r\n\r\n### Building PO file\r\n\r\n1. Change dir: `cd site`\r\n2. Run: `node po en_US --module=RealEstate` (replace `en_US` with a language code you need to translate to)\r\n\r\nThis will generate PO file in `site/build/` directory. You will need to translate this file.\r\n\r\n### Building language files from PO\r\n\r\nAssuming you have translated PO file in build directory with the same name as when it was generated.\r\n\r\n1. Change dir: `cd site`\r\n2. Run: `node lang en_US --module=RealEstate` (replace `en_US` with the target language code)\r\n\r\nThis will generate language files in `site/build/` directory. You will need to copy these files to `src/files/` directory and commit.\r\n\r\n## License\r\n\r\nReal Estate extension for EspoCRM is published under the GNU GPLv3 license.\r\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fespocrm%2Fext-real-estate","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fespocrm%2Fext-real-estate","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fespocrm%2Fext-real-estate/lists"}