Skip to content

Commit 854073a

Browse files
Update README
Had missed a line in the Lambda packaging instructions. Further small tweaks.
1 parent ebbf47c commit 854073a

File tree

2 files changed

+7
-8
lines changed

2 files changed

+7
-8
lines changed

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,14 +14,14 @@ Has the following components.
1414

1515
* A static [website](https://ica-egad.github.io/RiC-ResourceList/index.html), consisting of the HTML files in this repository along with the CSS file. No Javascript is used.
1616
* A master document `master-document/resource_list.csv` from which the static website is generated.
17-
* A very lightweight backend living in the cloud, fired as needed (function-as-a-service), functioning as reverse proxy towards GitHub for adding or editing resources via the website.
18-
* Three GitHub Actions, two of which are triggered by the backend to create a pull request updating the master document upon receipt of a resource addition or edit, and one of which re-generates the site upon the merging of such a pull request.
17+
* A very lightweight backend living in the cloud, fired as needed (function-as-a-service), functioning as a reverse proxy towards GitHub for adding or editing resources via the website.
18+
* Three GitHub Actions. Two are triggered by the backend upon a resource addition or edit; they create a pull request to update the master document. One re-generates the site upon the merging of such a pull request.
1919

2020
Guide to the scripts:
2121

22-
* Re-generation of the site is by means of the script `scripts/generated_site.sh`, which calls `scripts/resource_list.py` numerous times.
23-
* The script `scripts/handle_submission.py` defines the on-demand function which serves as the backend/reverse proxy in the cloud.
24-
* The script `scripts/update_master_document.py` handles the form submissions from the website for adding or editing a resource.
22+
* Re-generation of the site is by means of `scripts/generated_site.sh`, which calls `scripts/resource_list.py` numerous times. The latter is the heart of the tool.
23+
* The on-demand function which serves as the backend/reverse proxy in the cloud is defined by `scripts/handle_submission.py`.
24+
* The handling of the form submissions from the website for adding or editing a resource is carried out in `scripts/update_master_document.py`.
2525

2626

2727
Deployment

scripts/README.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,9 +21,8 @@ can be downloaded from the EGAD organisation Settings page at GitHub.
2121

2222
```
2323
mkdir package
24-
cd package
25-
zip -r ../handle_submission.zip .
26-
cd ../
24+
pip install -r requirements --target package
25+
zip -r handle_submission.zip package/
2726
zip handle_submission.zip egad_github_app_private_key.pem
2827
zip handle_submission.zip handle_submission.py
2928
```

0 commit comments

Comments
 (0)