Skip to content

Commit

Permalink
Minor fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
adityaoberai committed Jan 23, 2023
1 parent d87774f commit 5840e2e
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,23 +8,23 @@

## Components

* The [`main`](https://github.com/adityaoberai/SOS-MAUI) branch contains the **.NET MAUI 6** project used to build the Android app that gets the coordinates of the phone through the **.NET MAUI Essentials Geolocation API** and call the SOS **Appwrite Function**.
* The [`main`](https://github.com/adityaoberai/SOS-MAUI) branch contains the **.NET MAUI 6** project used to build the app that gets the coordinates of the phone through the **.NET MAUI Essentials Geolocation API** and call the SOS **Appwrite Function**.

* The [`appwrite-function`](https://github.com/adityaoberai/SOS-MAUI/tree/appwrite-function) branch contains the **Azure Function** that reverse geocodes the coordinates to get the address from the **Radar Geocoding API** and uses **Twilio Programmable Message** to send an SOS message to predecided number.
* The [`appwrite-function`](https://github.com/adityaoberai/SOS-MAUI/tree/appwrite-function) branch contains the **Appwrite Function** that reverse geocodes the coordinates to get the address from the **Radar Geocoding API** and uses **Twilio Programmable Message** to send an SOS message to predecided number.

## Steps To Setup

### For SOS Appwrite Function

* [Setup an Appwrite instance](https://appwrite.io/docs/installation), create a new admin account and then a new project
* Enable the **.NET 6.0 runtime for Appwrite Cloud Functions** (check the note below)
* [Setup an Appwrite instance](https://appwrite.io/docs/installation), create a new admin account and a new project
* Enable the **.NET 6.0 runtime for Appwrite Functions** (check the note below)
* Create an API Key with the `execution.write` scope enabled
* [Install the Appwrite CLI](https://appwrite.io/docs/command-line#installation) and login with your Appwrite credentials
* Create an account on [Twilio](https://twilio.com), obtain your Twilio Account SID and Auth Token from your Twilio console, and await a 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))
* Create an account on [Radar](https://radar.com) and grab an API key (*Test secret(server) should be fine*)
* Visit the SOS Appwrite Function Readme in the [`appwrite-function`](https://github.com/adityaoberai/SOS-MAUI/tree/appwrite-function) branch for more details on setting up and deploying the function

> Note: In order to enable the .NET runtime for Appwrite Cloud Functions, you need to update the `.env` file in the Appwrite installation folder. Find the file and add `dotnet-6.0` to the comma-separated list in the environment variable `_APP_FUNCTIONS_RUNTIMES`. This will make the .NET runtime available in Appwrite Functions. You can then load the updated configuration using the `docker-compose up -d` command.
> Note: In order to enable the .NET runtime for Appwrite Functions, you need to update the `.env` file in the Appwrite installation folder. Find the file and add `dotnet-6.0` to the comma-separated list in the environment variable `_APP_FUNCTIONS_RUNTIMES`. This will make the .NET runtime available in Appwrite Functions. You can then load the updated configuration using the `docker-compose up -d` command.
### For .NET MAUI App

Expand All @@ -34,7 +34,7 @@
```sh
dotnet restore
```
* Visit the `SOS\Constants` folder, create a class `AppwriteConstants.cs` as follows:
* Visit the `SOS\Constants` folder and create a class `AppwriteConstants.cs` as follows:
```csharp
namespace SOS.Constants
{
Expand Down

0 comments on commit 5840e2e

Please sign in to comment.