Create top-level README.

Makefile

@@ -23,8 +23,7 @@ dist/hff-entry-forms-web-${VERSION}.${TARGET_ENV}.tar.gz:
 	tar czf dist/hff-entry-forms-web-${VERSION}.${TARGET_ENV}.tar.gz -C web/dist .
 
 deploy-api:
-	make -C api build-image push-image
-	cd operations/terraform && terraform apply -target module.${TARGET_ENV}_env.aws_ecs_task_definition.hff_entry_forms_api -target module.${TARGET_ENV}_env.aws_ecs_service.hff_entry_forms_api
+	TARGET_ENV=${TARGET_ENV} make -C api build-image push-image publish
 
 deploy-web: dist/hff-entry-forms-web-${VERSION}.${TARGET_ENV}.tar.gz
 	mkdir -p temp-deploy/hff-entry-forms-web-${VERSION}

README.md

@@ -0,0 +1,79 @@
+# HFF Entry Forms
+
+## Local Development
+
+### Web
+
+```sh
+cd web
+npm install
+make serve & # or run in a separate terminal/pane
+make build # as-needed to rebuild (not using hot-reload)
+```
+
+### API
+
+```sh
+cd api
+make serve
+
+make serve-docker   # alternatively
+```
+
+## Procedures
+
+### Version Bump
+
+1. Ensure you know the current deployed version and the current "marked
+   version." Check the current deployed version by hitting the live API:
+
+       curl https://forms-api.hopefamilyfellowship.com/v1/version
+
+   and by querying ECR:
+
+       aws ecr describe-images --repository-name 063932952339.dkr.ecr.us-west-2.amazonaws.com/hff_entry_forms_api
+
+   Check the current "marked version" by looking at the latest git tag:
+
+       git tag -n
+
+2. If necessary, bump the version using:
+
+       make update-version
+
+   This will invoke `operations/update-version.sh` which:
+
+   - updates `web/package.json`,
+   - updates `web/package-lock.json`,
+   - updates `api/src/hff_entry_forms_apipkg/version.nim`,
+   - updates `api/hff_entry_forms_api.nimble`,
+   - commits all of the above, and
+   - tags the commit with the new version.
+
+#### Release Candidates (`-rcX` versions)
+
+When we are preparing to release version a new version, we first create release
+candidates. So, in preparation for releasing, for example, version 1.2.4, we
+do the following:
+
+```sh
+# Development is concluded, ready to release 1.2.4
+$ make update-version
+Last Version: 1.2.3
+New Version: 1.2.4-rc1
+
+$ TARGET_ENV=dev make deploy
+# verify successful build and deployment
+# validate the release in the dev environment
+
+$ make update-version
+Last Version: 1.2.4-rc1
+New Version: 1.2.4
+
+$ TARGET_ENV=dev make deploy
+# verify successful build and deployment
+
+$ TARGET_ENV=prod make deploy
+# verify successful build and deployment
+# validate the release in the prod environment
+```

api/test/tmodels.nim

@@ -4,7 +4,7 @@ import hff_entry_forms_apipkg/models
 
 suite "models":
 
-  test "asNotionPage(EventProposal)":
+  test "toPage(EventProposal)":
     let ep = EventProposal(
       name: "Test Event",
       description: "A test event.",
@@ -15,6 +15,6 @@ suite "models":
       date: parse("2021-10-30", "YYYY-MM-dd"),
       budgetInDollars: 56)
 
-    let expectedJson = """{"properties":{"Event":{"title":[{"type":"text","text":{"content":"Test Event"}}]},"Date":{"date":{"start":"2021-10-30T00:00:00.000-05:00"}},"Department":{"multi_select":[{"name":"Testing"}]},"Location":{"rich_text":[{"type":"text","text":{"content":"Hope Family Fellowship"}}]},"Owner":{"rich_text":[{"type":"text","text":{"content":"Jonathan Bernard"}}]},"State":{"select":{"name":"Proposed"}},"Visibility":{"select":{"name":"Public"}}},"children":[{"object":"block","type":"heading_2","heading_2":{"text":[{"type":"text","text":{"content":"Purpose"}}]}},{"object":"block","type":"paragraph","paragraph":{"text":[{"type":"text","text":{"content":"Event example for unit testing."}}]}},{"object":"block","type":"heading_2","heading_2":{"text":[{"type":"text","text":{"content":"Description"}}]}},{"object":"block","type":"paragraph","paragraph":{"text":[{"type":"text","text":{"content":"A test event."}}]}}]}"""
+    let expectedJson = """{"properties":{"Event":{"title":[{"type":"text","text":{"content":"Test Event"}}]},"Date":{"date":{"start":"2021-10-30T00:00:00-05:00"}},"Department":{"multi_select":[{"name":"Testing"}]},"Location":{"rich_text":[{"type":"text","text":{"content":"Hope Family Fellowship"}}]},"Owner":{"rich_text":[{"type":"text","text":{"content":"Jonathan Bernard"}}]},"State":{"select":{"name":"Proposed"}},"Visibility":{"select":{"name":"Public"}}},"children":[{"object":"block","type":"heading_2","heading_2":{"text":[{"type":"text","text":{"content":"Purpose"}}]}},{"object":"block","type":"paragraph","paragraph":{"text":[{"type":"text","text":{"content":"Event example for unit testing."}}]}},{"object":"block","type":"heading_2","heading_2":{"text":[{"type":"text","text":{"content":"Description"}}]}},{"object":"block","type":"paragraph","paragraph":{"text":[{"type":"text","text":{"content":"A test event."}}]}}]}"""
 
-    check $(ep.asNotionPage) == expectedJson
+    check $(ep.toPage) == expectedJson

operations/README.md

@@ -2,10 +2,12 @@
 
 ## System Components
 
-* DNS - hosted on GoDaddy
-* API Server - hosted on the `ortis` ECS cluster at JDB Software
+* DNS - managed by AWS
+* API Server - hosted on `sobeck.jdb-software.com`
 * API Loadbalancer - using the main load balancer for JDB Software
 * Web App - Served by CloudFront from an S3 bucket managed by JDB Software
 * Certificates - Manually created and validated for \*.HFF.com
-* Notion Integration - defined in Notion, token provided via AWS secrets
-  manager to the API instance running on the ortis cluster.
+* Notion Integration - defined in Notion, token provided via the environment
+  specific config files at `/etc/hff_entry_forms/{dev,prod}.env` and passed
+  into the docker container at runtime ad defined in the SystemD service file
+  (see `api/hff_entry_forms_api.service`)

web/README.md

@@ -1,24 +0,0 @@
-# hff-entry-form-web
-
-## Project setup
-```
-npm install
-```
-
-### Compiles and hot-reloads for development
-```
-npm run serve
-```
-
-### Compiles and minifies for production
-```
-npm run build
-```
-
-### Lints and fixes files
-```
-npm run lint
-```
-
-### Customize configuration
-See [Configuration Reference](https://cli.vuejs.org/config/).