Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/adityaoberai/ghwinit-randomwordoftheday
Appwrite Function to SMS a random word and its meaning
https://github.com/adityaoberai/ghwinit-randomwordoftheday
appwrite dotnet dotnet-6 twilio twilio-sms-api
Last synced: 6 days ago
JSON representation
Appwrite Function to SMS a random word and its meaning
- Host: GitHub
- URL: https://github.com/adityaoberai/ghwinit-randomwordoftheday
- Owner: adityaoberai
- Created: 2022-07-08T08:03:31.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2022-07-08T18:37:20.000Z (over 2 years ago)
- Last Synced: 2024-10-09T03:41:20.096Z (27 days ago)
- Topics: appwrite, dotnet, dotnet-6, twilio, twilio-sms-api
- Language: C#
- Homepage: https://youtu.be/avEIIpRsB-w
- Size: 9.77 KB
- Stars: 1
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Random Word Of The Day - Appwrite Cloud Function
## đ¤ Documentation
This function sends an SMS to a person with a [random word](https://random-word-api.herokuapp.com/home) and its [meaning](https://dictionaryapi.dev/).
_Example input:_
This function expects no input
_Example output:_
- **Appwrite Console Logs**
```json
{
"randomWord": "perambulating",
"meaning": "To walk about, roam or stroll.",
"twilioResponse": {
"Body": "Random Word Of The Day: \nperambulating means To walk about, roam or stroll.",
"NumSegments": "1",
"Direction": {},
"From": {},
"To": "\u002B919876543210",
"DateUpdated": "2022-07-08T07:59:31+00:00",
"Price": null,
"ErrorMessage": null,
"Uri": "/2010-04-01/Accounts/ACe29c144db149972dbf5427bbdd0c16dd/Messages/SM4cc2cf763c1e48668598bd0797093b40.json",
"AccountSid": "ACe29c144db149972dbf5427bbdd0c16dd",
"NumMedia": "0",
"Status": {},
"MessagingServiceSid": null,
"Sid": "SM4cc2cf763c1e48668598bd0797093b40",
"DateSent": null,
"DateCreated": "2022-07-08T07:59:31+00:00",
"ErrorCode": null,
"PriceUnit": "USD",
"ApiVersion": "2010-04-01",
"SubresourceUris": {
"media": "/2010-04-01/Accounts/ACe29c144db149972dbf5427bbdd0c16dd/Messages/SM4cc2cf763c1e48668598bd0797093b40/Media.json"
}
}
}
```
- **Message on Phone**
## đ Environment Variables
Go to Settings tab of your Cloud Function and add the following environment variables:
- `TwilioAccountSID`: Twilio Account SID
- `TwilioAuthToken`: Twilio Auth Token
- `TwilioPhoneNumber`: Twilio Phone Number to send the SMS from
- `ToPhoneNumber`: Phone Number to send the SMS to
> âšī¸ _The Twilio Account SID and Auth Token can be obtained from your Twilio console. You can purchase a Twilio phone number using [this guide](https://support.twilio.com/hc/en-us/articles/223135247-How-to-Search-for-and-Buy-a-Twilio-Phone-Number-from-Console)._
## đ Deployment
There are two ways of deploying the Appwrite function, both having the same results, but each using a different process. We highly recommend using CLI deployment to achieve the best experience.
Make sure to set a CRON schedule in the Settings tab of the function on the Appwrite Console if you want the function to be triggered by a schedule.
### Using CLI
Make sure you have [Appwrite CLI](https://appwrite.io/docs/command-line#installation) installed, and you have successfully logged into your Appwrite server. To make sure Appwrite CLI is ready, you can use the command `appwrite client --debug` and it should respond with green text `â Success`.
Make sure you are in the same folder as your `appwrite.json` file and run `appwrite deploy function` to deploy your function. You will be prompted to select which functions you want to deploy.
### Manual using tar.gz
Manual deployment has no requirements and uses Appwrite Console to deploy the tag. First, enter the folder of your function. Then, create a tarball of the whole folder and gzip it. After creating `.tar.gz` file, visit Appwrite Console, click on the `Deploy Tag` button and switch to the `Manual` tab. There, set the `entrypoint` to `src/Index.cs`, and upload the file we just generated.