Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion addons/serverless-schedule-manager/.twilioserverlessrc
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"commands": {},
"environments": {},
"projects": {},
"runtime": "node18" /* The version of Node.js to deploy the build to. */,
"runtime": "node22" /* The version of Node.js to deploy the build to. */,
// "assets": true /* Upload assets. Can be turned off with --no-assets */,
// "assetsFolder": null /* Specific folder name to be used for static assets */,
// "buildSid": null /* An existing Build SID to deploy to the new environment */,
Expand Down
340 changes: 264 additions & 76 deletions addons/serverless-schedule-manager/package-lock.json

Large diffs are not rendered by default.

8 changes: 4 additions & 4 deletions addons/serverless-schedule-manager/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -12,21 +12,21 @@
"lint:report": "npm run lint -- --output-file eslint_report.json --format json"
},
"dependencies": {
"@twilio/runtime-handler": "2.0.0",
"@twilio/runtime-handler": "2.0.1",
"axios": "^1.12.2",
"form-data": "^4.0.4",
"lodash": "^4.17.21",
"luxon": "^3.0.1",
"rrule": "^2.7.1",
"twilio": "^4.23.0",
"twilio": "^5.8.0",
"twilio-flex-token-validator": "^1.5.6"
},
"devDependencies": {
"eslint": "^8.37.0",
"eslint-config-twilio": "^2.0.0",
"twilio-run": "^4.0.0"
"twilio-run": "^4.2.0"
},
"engines": {
"node": ">=18"
"node": ">=22"
}
}
25 changes: 15 additions & 10 deletions docs/docs/getting-started/01_run-locally.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,18 @@ If you wish to modify the template in any way, you will need to set up your deve

## Prerequisites

- you are running node v18 or above
- twilio cli 5.22.0 or above is [installed](https://www.twilio.com/docs/twilio-cli/getting-started/install) (`twilio --version`)
- twilio flex plugins 7.1.0 or above is [installed](https://www.twilio.com/docs/flex/developer/plugins/cli/install#install-the-flex-plugins-cli) (`twilio plugins`, `twilio plugins:install @twilio-labs/plugin-flex@latest`)
- twilio serverless plugin 3.1.6 or above is [installed](https://www.twilio.com/docs/labs/serverless-toolkit/getting-started#install-the-twilio-serverless-toolkit) (`twilio plugins` `twilio plugins:install @twilio-labs/plugin-serverless@latest`)
- `twilio profiles:list` has an active account set.
- have the twilio auth token for your account ready (you can find this in the [Twilio Console](https://console.twilio.com/))
- If you are running Windows, ensure you are using Git Bash to execute the commands when working with the template, rather than Command Prompt or PowerShell.
- Node.js 22 or above is installed
- Twilio CLI 6.1.0 or above is [installed](https://www.twilio.com/docs/twilio-cli/getting-started/install)
- To check your currently installed version, run `twilio --version`
- Twilio CLI Flex plugin 7.1.2 or above is [installed](https://www.twilio.com/docs/flex/developer/plugins/cli/install#install-the-flex-plugins-cli)
- To check your currently installed version, run `twilio plugins`
- To install the latest version, run `twilio plugins:install @twilio-labs/plugin-flex@latest`
- Twilio CLI serverless plugin 3.3.0 or above is [installed](https://www.twilio.com/docs/labs/serverless-toolkit/getting-started#install-the-twilio-serverless-toolkit)
- To check your currently installed version, run `twilio plugins`
- To install the latest version, run `twilio plugins:install @twilio-labs/plugin-serverless@latest`
- `twilio profiles:list` has an active account set
- Have the Twilio auth token for your account ready (you can find this in the [Twilio Console](https://console.twilio.com/))
- If you are running Windows, ensure you are using Git Bash to execute the commands when working with the template, rather than `cmd` or PowerShell.
- We also need to instruct `npm` to use Git Bash for executing scripts. To do so, run: `npm config set script-shell "C:\\Program Files\\git\\bin\\bash.exe"` (adjust as needed for the installed Git location)

:::caution Feature Functionality
Expand All @@ -37,16 +42,16 @@ twilio profiles:list
```bash
npm install
```
5. follow the prompt and provide your auth token
5. Follow the prompt and provide your auth token

6. Run the serverless functions, Insights proxy, and plugin together locally by running the following at the top level of the checkout
6. Run the serverless functions, Insights proxy, and plugin together locally by running the following at the top level of the repository

```bash
npm start
```

:::info Feature Limitation
the admin panel is disabled by default when working locally. See the [admin panel docs](/feature-library/admin-ui) for more information
The admin panel is disabled by default when working locally. See the [admin panel docs](/feature-library/admin-ui) for more information.
:::

:::caution Development Gotcha
Expand Down
Loading