Improve documentation

Author: staadecker

README.md

@@ -10,7 +10,6 @@ This system aims to meet those needs.
 ## System description
 
 This system tracks UTOC's members in a Google Sheets database.
-Members can be added manually by adding new rows to the database.
 The database is synchronized with a Google Groups mailing list.
 Finally, a membership sign up form is added to UTOC's website.
 The sign up form asks for membership info (name, email, etc.) as well as payment through PayPal.
@@ -24,35 +23,37 @@ This section presents the 4 different components of the system. Visit each compo
 
 The first component is a membership sign up form.
 This form is embedded on our squarespace website and collects both membership information as well as a payment through PayPal buttons.
+This component is simply some HTML + Javascript that is hosted on Firebase Hosting.
 
 ### [`membership-form-backend-trigger`](./components/membership-form-backend-trigger)
 
 The second component is what receives requests from the membership sign up form.
 It will read the request, send it on to `membership-form-backend` and then redirect the user to our welcome page.
+It is hosted as a Google Cloud Function.
 
 ### [`membership-form-backend`](./components/membership-form-backend)
 
-The third component receives the membership sign up form request via `membership-form-backend-trigger`.
+The third component receives the membership sign up request via `membership-form-backend-trigger`.
 The function verifies that the PayPal transaction is valid, adds the member to our Google Sheets database & Google Group and sends the member a welcome email.
+It is hosted as a Google Cloud Function.
 
 ### [`expired-members-remover`](./components/expired-members-remover)
 
-The fourth component, is a cloud function that runs daily.
-This function deletes expired members from the Google group and notifies them. This component is a work in progress.
+The fourth component, is a script that removes expired members from the mailing system
+and sends members an email notifying them of their membership expiry. 
+It is hosted as a Google Cloud Function that is triggered daily by the Google Cloud Scheduler.
 
 ## Next steps
 
 If you want to learn more about the system, how it works, how to run it locally, and how to test it, then read the following docs.
 
-- [System Architecture](./docs/System%20architecture.md)
+- [Adding a Member Manually](./docs/Adding%20a%20Member%20Manually.md)
 
-- [Developer Setup](./docs/Developer%20Setup.md)
-
-- [Testing the system](./docs/Testing.md)
+- [Docs for developers](./docs/For%20Developers.md)
 
 - README's for each component (links in headers above)
 
 ## Contact Info
 
-The code was developed by Martin Staadecker, webmaster for UTOC in 2020-21.
+The code was developed by Martin Staadecker, webmaster for UTOC from 2020 to 2022.
 I'm reachable at [[email protected]](mailto:[email protected]) and happy to answer any questions.

components/membership-form-backend-trigger/README.md

@@ -17,7 +17,7 @@ This is why we use the middleware which makes use of the asynchronous Pub/Sub sy
 
 There isn't much to test in such a simple function, however one can deploy it to the test project and verify that
 it forwards all the frontend request data. Use `yarn workspace membership-form-backend-trigger deploy` to deploy
-the function to the test project.
+the function to the test project. To test locally run `yarn workspace membership-form-backend-trigger start`
 
 ## Deploying
 

docs/Developer Setup.md

@@ -0,0 +1,41 @@
+# For developers
+
+## Get set up
+
+1. [Install NodeJS 10](https://nodejs.org/en/download/).
+
+2. Install the [Google Cloud SDK](https://cloud.google.com/sdk/docs).
+
+3. Clone this repository.
+
+4. In the cloned repository, run `yarn` or `yarn install` in the root directory to install all the packages.
+
+5. Run `yarn auth` and login with your `@utoc.ca` account.
+   This will allow you to access the staging environment.
+   You will need to run this command every 8 hours to re-authenticate.
+   
+## Different environments
+
+There are 3 environments that you'll deal with.
+
+1. Local environment (referred to as dev). This runs on your computer only.
+
+2. Test environment. This is deployed to the internet the same way as the production environment, 
+   obviously using a test database and mailing list. The only difference is it uses a Developer PayPal 
+   account, so you don't actually need to pay money to test the system.
+   
+3. Production environment. This is what the public sees.
+
+## Running the dev environment
+
+Follow the instructions under [`components/membership-form-frontend/README.md`](components/membership-form-frontend/README.md).
+
+## Deploying
+
+The code is deployed to production every time a new tag is released on the master branch
+on GitHub. The deployment pipeline can be managed through Google Cloud Build.
+
+## More questions ?
+
+If the documentation here is insufficient, contact me and I'll be happy to walk you through
+any parts of the system. Contact information at the bottom of the main README.