{"id":19506069,"url":"https://github.com/espocrm/ext-sms-providers","last_synced_at":"2025-04-26T02:32:19.139Z","repository":{"id":42573590,"uuid":"426999487","full_name":"espocrm/ext-sms-providers","owner":"espocrm","description":"Implementations for different SMS providers for EspoCRM. Can be used for 2-factor authentication or automatic SMS sending via Workflow and BPM tools.","archived":false,"fork":false,"pushed_at":"2024-10-23T09:20:30.000Z","size":102,"stargazers_count":19,"open_issues_count":2,"forks_count":14,"subscribers_count":7,"default_branch":"master","last_synced_at":"2025-04-24T07:11:31.567Z","etag":null,"topics":["espocrm","extension","sms"],"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","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":"2021-11-11T12:50:38.000Z","updated_at":"2024-12-06T12:52:34.000Z","dependencies_parsed_at":"2024-10-23T13:25:41.465Z","dependency_job_id":null,"html_url":"https://github.com/espocrm/ext-sms-providers","commit_stats":null,"previous_names":[],"tags_count":7,"template":false,"template_full_name":"espocrm/ext-template","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/espocrm%2Fext-sms-providers","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/espocrm%2Fext-sms-providers/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/espocrm%2Fext-sms-providers/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/espocrm%2Fext-sms-providers/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/espocrm","download_url":"https://codeload.github.com/espocrm/ext-sms-providers/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":["espocrm","extension","sms"],"created_at":"2024-11-10T22:35:31.700Z","updated_at":"2025-04-26T02:32:18.899Z","avatar_url":"https://github.com/espocrm.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"# SMS Providers for EspoCRM\r\n\r\nAn installable extension.\r\n\r\n\r\n## Supported SMS Providers\r\n\r\n* Twilio\r\n* Spryng\r\n* sms77\r\n* smstools\r\n* [SerwerSms](https://dev.serwersms.pl/en/https-api-v2/introduction)\r\n* [Verimor](https://verimor.com.tr)\r\n* [GatewayAPI](https://gatewayapi.com)\r\n\r\n## Setting up\r\n\r\n1. Install the extension.\r\n2. At Administration \u003e SMS, select the needed SMS provider. Specify From Number (if needed). \r\n3. At Administration \u003e Integration, open the needed SMS provider and entered required credentials.\r\n\r\n\r\n## Configuration\r\n\r\nCreate `config.json` file in the root directory. You can copy `config-default.json` and rename it to `config.json`.\r\n\r\nWhen 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.9.2`);\r\n* database - credentials of the dev database;\r\n* install.siteUrl - site url of the dev instance;\r\n* install.defaultOwner - a webserver owner (important to be set right);\r\n* install.defaultGroup - a webserver group (important to be set right).\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\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### Copying extension files to EspoCRM instance\r\n\r\nYou need to run this command every time you make changes in `src` directory and you want to try these changes on Espo instance.\r\n\r\nCommand:\r\n\r\n```\r\nnode build --copy\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.\r\n\r\n\r\n## Configuring IDE\r\n\r\nYou need to set the following paths to be ignored in your IDE:\r\n\r\n* `build`\r\n* `site/build`\r\n* `site/custom/Espo/Modules/SmsProviders`\r\n* `site/tests/unit/Espo/Modules/SmsProviders`\r\n* `site/tests/integration/Espo/Modules/SmsProviders`\r\n\r\n## License\r\n\r\nChange 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.\r\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fespocrm%2Fext-sms-providers","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fespocrm%2Fext-sms-providers","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fespocrm%2Fext-sms-providers/lists"}