TrashMob.eco

Meet up. Clean up. Feel good.

What is TrashMob?

TrashMob.eco is a platform dedicated to organizing groups of people to clean up the world we live in. Users create cleanup events, publicize them, and recruit people to join up, as well as ask for assistance from communities and partners to help haul away the garbage once it is gathered. The idea is to turn what can be an intimidating process for event organizers into a few clicks and simple forms. And once the process is simple, events will spring up all over the world, and the cleanup of the world can begin.

Where did this idea come from?

Years ago, Scott Hanselman (and others at Microsoft) built out the NerdDinner.com site as a demo of the capabilities of ASP.NET MVC. I actually went to a bunch of the nerd dinners. They were fantastic and had a huge roll in my career, including eventually leading me to join Microsoft. This site is based on both that code and the idea that getting people together to do small good things results in larger good things in the long term.

My passion is fixing problems we have on the planet with pollution and climate change. I've been thinking about what technology can do to help in these areas, without creating more problems. And I keep coming back to the thought that a lot of this is a human problem. People want to help and they want to fix things, but they don't know where to start. Other people have ideas on where to start, but not enough help to get started.

I read about a guy in California named Edgar McGregor, who has spent over 1100 days cleaning up a park in his community, two pails of litter at a time, and I thought, that was a great idea. His actions inspired me to get out and clean up a local park one Saturday. It was fun and rewarding and other people saw what I was doing on my own and I know I have already inspired others to do the same. And then I passed by an area of town that is completely covered in trash and I thought "this is too much for me alone. It would be great to have a group of people descend on this area like a mob and clean it up in an hour or two". And my idea for TrashMob.eco was born.

Basically, TrashMob is the NerdDinner.com site re-purposed to allow people to start mobs of their own to tackle cleanup or whatever needs doing. And I keep coming up with more and more ideas for it. I'm hoping this site grows organically because of the good that we can do we get together.

What is the website address?

To see what is currently deployed to the prod environment, go to: https://www.trashmob.eco

To see what is currently deployed to the dev environment, go to: https://as-tm-dev-westus2.azurewebsites.net/

FAQ

What is the current state of this project?

As of 5/15/2022, we are now in full production launch. The site is up and running and people are using it ot help organize litter cleanups! TrashMob.eco is now a 501(c)(3) non-profit in the United States. We are working on new features all the time!

Are you looking for contributors?

ABSOLUTELY! Ping [email protected] if you want to get involved. All kinds of skills are needed, from reactjs to website design, to aspnet core, to .NET MAUI, to PowerBI, to deployment / github skills. If you have a couple of hours a week, and want to contribute, let us know!

I have an idea for a TrashMob feature!

Fantastic! We want to build this out to be best platform on the internet! But before you send us your idea, please take a look at the lists of projects and issues we already have going. We may already be working on your idea. If your idea is not there, feel free to reach out to us at [email protected]

Development Notes

Getting Started - Development

1. You must install the .NET 8 SDK
2. Install Visual Studio Code
3. Connect to github and clone the repo
4. Send your github id to [email protected] to be added as a contributor to the repository
5. Install the Azure CLI

To use the Shared Dev Environment

If you are not doing any database changes (i.e. design work, error handling, etc) you can save yourself time and money by doing the following and using the shared Dev environment:

1. Send the email address you use on GitHub to [email protected]
2. TrashMob will add you as a contributor to the Sandbox subscription
3. TrashMob will add you to the Dev KeyVault with Secret Get and List permissions
4. Log in to the Sandbox subscription, and go to the Dev Azure SQL Database
5. Click on Firewalls and Virtual Networks
6. Add a new Rule with your email address as the name, with the start and end ip address set as your Client IP Address (see the line above the form for what Azure thinks your IP address is)
7. Save changes
8. Run the following script on your machine from the TrashMob folder in the project to set up your dev machine to run the project locally. You must be logged into Azure in your PowerShell window in the correct subscription

.\setupdev.ps1 -environment dev -region westus2 -subscription 39a254b7-c01a-45ab-bebd-4038ea4adea9

To view the Swagger for the TrashMobAPI (Develpment Environment only)

1. Start the TrashMob project in Visual Studio
2. Go to https://localhost:44332/swagger/index.html
3. If you want to test the API, you will need to log in to the site first, and then use the token from the site to authenticate in the Swagger UI.

To set up your own environment to test in:

You must use this if you are making database changes to ensure you do not break the backend for everyone else:

1. Follow the Infrastructure Deployment Steps (here)[.\Deploy\readme.md].
2. Run the following script on your machine from the TrashMob folder in the project to set up your dev machine to run the project locally. You must be logged into Azure in your PowerShell window in the correct subscription

.\setupdev.ps1 -environment <yourenv> -region <yourregion> -subscription <yourazuresubscription>

i.e.
.\setupdev.ps1 -environment jb -region westus2 -subscription <insert guid here>

Setting up your launchsettings.json for website development

Because of RedirectUrls, life is a lot easier if you stick with the same ports as everyone else.

cd to the TrashMob/Properties folder: Add the following launchsettings.json file (may need to create it if you don't have it already):

{
  "iisSettings": {
    "windowsAuthentication": false,
    "anonymousAuthentication": true,
    "iisExpress": {
      "applicationUrl": "http://localhost:44332/",
      "sslPort": 44332
    }
  },
  "profiles": {
    "IIS Express": {
      "commandName": "IISExpress",
      "launchBrowser": true,
      "environmentVariables": {
        "ASPNETCORE_ENVIRONMENT": "Development"
      }
    },
    "TrashMob": {
      "commandName": "Project",
      "launchBrowser": true,
      "environmentVariables": {
        "ASPNETCORE_ENVIRONMENT": "Development"
      },
      "applicationUrl": "https://localhost:44332;http://localhost:5000"
    }
  }
}

Getting Started - Mobile Development

The mobile app is written using .NET MAUI. It requires a few prerequisites in order to get it compiling and running.

If you are working on a Windows machine:

1. Ensure you have installed the latest version of Visual Studio and the .NET MAUI Framework option

2. Install Android Studio https://developer.android.com/studio

3. Create an Android Emulator device in Android Studio

4. Load the TrashMobMobileApp.sln Project in Visual Studio.

5. Set your startup project to TrashMobMobileApp

6. In order to have the maps feature work, you will need to do one of the following options:

   1. Create your own key
      1. Create a Google Maps account: https://developers.google.com/maps/gmp-get-started
      2. Get your Google API Key from your Google Project
      3. Open the Platforms/Android/AndroidManifest.xml file
      4. Paste your GoogleMaps key to the value of the following line:

          <meta-data android:name="com.google.android.geo.API_KEY" android:value="<insert your api key here>" />

   2. Get the dev key from the dev keyvault
      1. See if you have read access to the following keyvault secret: https://portal.azure.com/#@jobeedevids.onmicrosoft.com/asset/Microsoft_Azure_KeyVault/Secret/https://kv-tm-dev-westus2.vault.azure.net/secrets/Android-Google-ApiKey-Dev
      2. If you don't have access, send a message to the team contact
      3. If you do have access copy the value there
      4. Open the Platforms/Android/AndroidManifest.xml file
      5. Paste your GoogleMaps key to the value of the following line:

          <meta-data android:name="com.google.android.geo.API_KEY" android:value="<insert your api key here>" />

   Never check in any file that contains the api key!!!!!

If you are working on a Mac:

1. Ensure you have installed the latest version of Visual Studio and the .NET MAUI Framework option
2. Load the TrashMobMobileApp.sln Project in Visual Studio.
3. Set your startup project to TrashMobMobileApp
4. More detail needed here

Web App Setup:

1. Send your github id to [email protected] to be added as a contributor to the repository and on Azure subscription
2. Clone Repository
3. Download & Install VS Code
4. Download & Install .NET 8 SDK
5. Install the Azure CLI
6. Run az login command to login to Azure
7. Navigate to TashMob/TrashMob directory and run this command to start the Web API and Client App servers. dotnet run --environment Development

To Build the Web App:

In the Trashmob project folder, run the following command:

dotnet build

To Run the Web App:

In the Trashmob project folder, run the following command:

dotnet run

or if using Visual Studio, set the TrashMob project as the start up project and hit F5.

If a browser does not open, open one for yourself and go to https://localhost:44332

If the app loads, but data does not, it is likely that the firewall rule is not set up correctly. Sometimes the IP address the Web Portal displays is different from the IP address of your machine. If you run into this issue, look in the debug window of VSCode. It will report a failure, and show that your actual IP Address is not enabled to access the database.

1. Copy the IP Address from the error in VS Code
2. Log in to the Sandbox subscription, and go to the Dev Azure SQL Database
3. Click on Firewalls and Virtual Networks
4. Add a new Rule with your email address as the name, with the start and end ip address set as your Client IP Address (see the line above the form for what Azure thinks your IP address is)
5. Save changes

User Stories for the TrashMob.eco Website

See the Website User Stories document for a list of user stories that have been implemented in the site.

User Stories for the TrashMob.eco Mobile App

See the Mobile App User Stories document for a list of user stories that have been implemented in the mobile apps.

Data Elements and Concepts

See the Data Elements and Concepts document for a description of all of the core data elements and concepts in the TrashMob.eco Platform.

Testing the Web App

As the site's feature set has grown, so have the scenarios that need to be tested after large changes have been made. Please see the Test Scenarios document for a list of checks that should be run. At some point we will need to automate these tests.

To update the UI only (React app):

In the Trashmob/client-app project folder, run the following command:

1. npm i to install the dependencies
2. npm start to start the web app

Instructions to come for the Sign In to have access to all pages.

To Update the Database Model

The project uses Entity Framework Core V8 Model-First database updates.

1. Update the models / MobDbContext as needed in the repo.
2. To create the migration, do either of the following steps

In VS Code

dotnet ef migrations add <YourMigrationName>

or in Visual Studio Package Manager Console

First, set the Default Project to TrashMob.Shared, then run the following command:

  EntityFrameworkCore\Add-Migration <YourMigrationName>

3. In VS Code in the TrashMob Folder, run the following command

dotnet ef database update

Allowing the App To Send Email

This is a pay-per-use feature, so, for the most part, we're going to try to limit the number of people developing with this. To not send email, make sure to set the following user secret on your dev box

  dotnet user-secrets set "sendGridApiKey" "x"

To test sending email, copy the "sendGridApiKey" from the dev keyvault to your machine and repeat the above, substituting in the real key.

A note on Azure Maps usage

The call to find the distance between two points in Azure Maps is only available in S1 (Gen 1) or Gen2 Maps. This is significantly more expensive than the S0 maps, so for now, we default to S0 for all dev deployments, and have manually set Prod to Gen2. It is not recommended to rerun the infrastructure deployments to Prod, as this will overwrite this setting.

In the future, we may want to optimize the use of this function to reduce costs.

How do I deploy the Azure Web App from GitHub?

The Dev site is automatically deployed with each push to the Main branch via a GitHub action. This is the preferred method of updating the Development Server. If you need to push an update from your development machine instead, please let the team know that there are changes in the environment pending checkin.

The Production site is manually deployed via a GitHub action from the release branch. This is the ONLY way production should be updated.

How do I deploy the Azure Web App from my PC?

Use Visual Studio Publish to publish the site to the dev server.

If setting up a new environment, you will need to add the IP Address of the App Service to the list of IP Addresses accessible in the SQL Server. This needs to be automated in the future to make sure that a change to an IP address doesn't break the site.

The site is asking me to login

If you try to access a secure page, you will need a user id on the site. When you hit a secured page, the site will redirect you to a sign in page. Click the Sign up now link at the bottom of the login box. Multiple identity providers are now available, including Facebook, LinkedIn, Google, and Microsoft, along with the TrashMob tenant itself if you prefer not to use an integrated signup.

How to Change Mobile App from Test to Prod

It is currently hard-coded in the Mobile app that if you run a Debug build, you will point to the test environment, and if you run the release build, you will point to the production environment.

The Release build is the one that is published to the app stores. We are working on having a second app store entry for testing only.

My Android Pull Request is Failing with Unable to Open jar File

In Debug mode, by default, the Android package format is set to apk, and does not build the bundle needed for signing. In order to change that

1. Open the TrashMobMobileApp.sln in Visual Studio
2. Right click on the TrashMobMobileApp project
3. Select "Properties"
4. Go to the Android Settings / Options
5. Change the Android Package Format for Debug & net8.0-android to "bundle" instead of "apk".
6. Save your changes and push to your branch.

Note: this may make deployments to your local emulator slower (more data must be copied into the emulator session). You can change this back to "apk" for local development, but failure to switch it back to "bundle" before checkin will cause the PR build to fail. There may be a way to pass this setting in on the command line for the publish step. That has not yet been investigated.

How do I get a test distribution of the Mobile App?

• The test mobile app for Android is available for download by registering as an Internal Tester on the Google Play Store. To do this, send an email to [email protected] requesting access to the test builds, specifying that you would like access to the Android Test build.
• The test mobile app for iOS is available for download by registering as a TestFlight tester. To do this, send an email to [email protected] requesting access to the test builds, specifying that you would like access to the iOS Test build.

How do I get a production distribution of the Mobile App?

The production mobile app can be downloaded here:

Android

iOS

IFTTT Testing

IFTTT.com testing is currently in progress. There are a couple of steps needed to get this working.

1. Log in to the TrashMob.eco Dev site, with the User ID you wish to use for testing.
2. Hit F-12 to open the developer tools
3. Go to the Network tab
4. Click on the 'My Dashboard' link in the top of the TrashMob.eco web page
5. In the network tab, look for a call to the TrashMob.eco api.
6. Click on the call, and look for the Authorization header in the Request Headers section.
7. Copy the value of the Authorization header
8. Log in to the Azure Portal, and go to the Sandbox subscription
9. Go to the Dev KeyVault
10. Create a new version of the 'IFTTTAuthToken' secret with the AuthHeader value as the value of the secret
11. Go to IFTTT.com and log in with an ID which has access to the TrashMobDev_Eco service
12. Run the Endpoint Tests

IFTTT Test User ID

• The test user id needed for submitting the IFTTT tests is stored in the Dev KeyVault as IFTTTTestUserId.
• The test user password needed for submitting the IFTTT tests is stored in the Dev KeyVault as IFTTTPasswordWebsite.
• The password needed for logging in to the Email account for the test user id is stored in the Dev KeyVault as IFTTTTestPassword.

SSL Cert Update Instructions

Every year, the SSL certificate for the TrashMob.eco site will need to be updated. The process for updating the certificate is stored in the TrashMob.eco OneNote under "Renewing the SSL Certificate".

Android App Signing Instructions

Test Environment

• To generate a new keystore file, follow: https://developer.android.com/studio/publish/app-signing#generate-key
• For the existing JKS:
  • The Android app is signed with a keystore file which is stored as a base 64 encoded string in the Prod KeyVault as Dev-Android-JKS
  • The password for the keystore is stored in the Prod KeyVault as Dev-android-JKS-Password.
  • The alias for the key is "upload"
  • To generate a new Key, extract the base64 keystore file from the KeyVault, and then save it as a KeyStore file using the following powershell command:

• $base64 = ""
• $bytes = [Convert]::FromBase64String($base64)
• [System.IO.File]::WriteAllBytes("C:\temp\Dev-Android-JKS.jks", $bytes)

• Then, open the command prompt and run the following command to generate a new key:

  keytool -export -rfc -keystore your-upload-keystore.jks -alias upload-alias -file

• Follow the instructions in the link above to set the key for the app in the Google Play Console.
• Note that the key must be set in the Google Play Console before the app can be uploaded to the Play Store and that changing the key will require a few days for the change to take effect.
• In order to have the GitHub actions work, you will need to update the following secrets in the GitHub repository in the Test environment:
  • ANDROID_KEYSTORE_PASSWORD
  • ANDROID_KEYSTORE
• The alias is passed into the workflow as a parameter, so it does not need to be updated in the secrets.

Production Environment

• To generate a new keystore file, follow: https://developer.android.com/studio/publish/app-signing#generate-key
• For the existing JKS:
  • The Android app is signed with a keystore file which is stored as a base 64 encoded string in the Prod KeyVault as Prod-Android-JKS (not ready yet)
  • The password for the keystore is stored in the Prod KeyVault as Dev-android-JKS-Password. (Not ready yet)
  • The alias for the key is "upload" (Not ready yet)
  • To generate a new Key, extract the base64 keystore file from the KeyVault, and then save it as a KeyStore file using the following powershell command:

• $base64 = ""
• $bytes = [Convert]::FromBase64String($base64)
• [System.IO.File]::WriteAllBytes("C:\temp\Prod-Android-JKS.jks", $bytes)

• Then, open the command prompt and run the following command to generate a new key:

  keytool -export -rfc -keystore your-upload-keystore.jks -alias upload-alias -file

• Follow the instructions in the link above to set the key for the app in the Google Play Console.
• Note that the key must be set in the Google Play Console before the app can be uploaded to the Play Store and that changing the key will require a few days for the change to take effect.
• In order to have the GitHub actions work, you will need to update the following secrets in the GitHub repository in the Prod environment:
  • ANDROID_KEYSTORE_PASSWORD
  • ANDROID_KEYSTORE
• The alias is passed into the workflow as a parameter, so it does not need to be updated in the secrets.

iOS App Signing Instructions

Test Environment

TBD

Production Environment

TBD

Deployment Instructions - Mobile App

Updating the Tag (rarely needed)

When needing to update the major and minor versions of the app, we need to push a new Tag to the repository. This is done by the TrashMob team, and not by individual developers. The steps are as follows:

1. Open a terminal window in the TrashMob repo folder
2. Ensure you are on the main branch
3. Run the following command to create a new tag where x is the major version and y is the minor version:

git tag x.y
git push origin --tags

Note that the Main and Release branches have different tags. The Main branch is for the Test environment, and the Release branch is for the Prod environment. To update the Release branch, you must be on the Release branch, then do the following command:

git tag x.y release
git push origin --tags

Deploying to the Test Stores

Deploying the mobile app to the app stores is a multi-step process.

1. The Workflows in GitHub Main are set to deploy an instance of the app to the Test Apple and Google Play store apps. This is done automatically with each push to the Main branch.
   1. For the Apple Dev store, go to https://appstoreconnect.apple.com/apps/1661581619/testflight/ ios and ensure there are no pending checks. If there are, the app will not be updated, and users will not get an update email.
   2. For the Google Play store, go to https://play.google.com/console/u/0/developers/8993160244638881894/app/4973591329514420131/app-dashboard. 1. Click on Internal Testing to see the list of version that have been uploaded. 1. When the internal testing is complete, click on the Promote to Open Testing button to move the app to the open testing stage
2. The Workflows in GitHub Release are set to deploy an instance of the app to the Prod Apple and Google Play store apps. This is done automatically with each push to the Release branch.
3. For the Apple Prod store, go to https://appstoreconnect.apple.com/apps/1599996743/testflight/ios and ensure there are no pending checks. If there are, the app will not be updated, and users will not get an update email.
4. For the Google Play store, go to https://play.google.com/console/u/0/developers/8993160244638881894/app/4972402459959745838/app-dashboard. 1. Click on Internal Testing to see the list of version that have been uploaded. 1. When the internal testing is complete, click on the Promote to Open Testing button to move the app to the open testing stage
5. The app must be manually submitted to the Apple and Google Play stores but only on the Prod stores. This is done by the TrashMob.eco team.