MAC-FC: README updates and bug fixes

Purpose

The MAC-FC team has been asked to contribute to the development of the QuickStart, and in this process we have set up our own QuickStart repo and run the sample app locally and deployed it to AWS. This change bundles together README updates, bug fixes, and general cleanup that we have done in that process. Our hope is that these can be incorporated into the template repository to benefit future users of the QuickStart (note that these changes will likely not be of interest or value to current users who have already branched off from this template repo).

Note to reviewers: we've done our best to get up to speed on the QuickStart and suggest helpful and relevant changes. However, it's likely that there are still places where we lack context for our changes; don't hesitate to point them out!

For more detailed notes on the changes, see the relevant pull requests at the macfc-quickstart repo. I'll summarize the changes here for convenience.

READMEs

We fleshed out the top-level README and service-specific READMEs, and also added a README for the services folder with details that are common to all services. We also updated the README located in the tests folder.

Bug Fixes

re-order a number of the serverless commands in dev.ts to fix errors encountered when running locally
Initialize Dynamo client with a config to fix failing updateItem call
fix bug in the sed command used in output.sh that led to the last value in the YAML output by serverless info being omitted
fix issue with comparing the string "true" to the value stored in SSM for boostrapUsersEnabled in the ui-auth service
remove calls to sh in configure_local.sh that fail on Linux machines without sh installed
allow the sync lambda to run without error if the parameters for GitHub repo/organization projects are not set
fix logical operator in script that validates branch names

Cleanup and Reorganization

standardize scripts to use the .sh extension and snake_case
in cases where there was more than one script in a given folder, move to a scripts folder
reorganize the tests folder to remove nesting and duplicate package.json/cypress.json files
standardize on yarn as a script runner
refactor scripts to use the top-level .github directory for path references (rather than relative paths, which can break if the folder structure changes)
remove commented-out code
remove scripts that seem unused or outdated

Linked Issues to Close

N/A

Approach

We tried to approach this as if we were a new user of the QuickStart, asking ourselves:

is the documentation clear and complete?
do the tools and processes defined in the documentation work without error?

Learning

We read extensively on the Serverless framework and on AWS documentation for the resources used by the QuickStart services.

Assorted Notes/Considerations

Manual testing

ran the QuickStart locally, in AWS on MAC-FC infra (across 2 AWS accounts), and with a local frontend against deployed backend services
- includes deploying and destroying multiple stages/branches
deployed the .sechub service
more detailed info on manual tests can be found in the PR notes for each change in the macfc-quickstart repo

Pull Request Creator Checklist

[ ] This PR has an associated issue or issues.
[ ] The associated issue(s) are linked above.
[ ] This PR meets all acceptance criteria for those issues.
[ ] This PR and linked issue(s) are adequately documented
[ ] This PR and linked issues(s) are a complete description of the changeset; an individual or team should be able to understand the issue(s) and changes by reading through this PR and it's links, with no further interaction.
[ ] Someone has been assigned this PR.
[ ] At least one person has been marked as reviewer on this PR.

Pull Request Reviewer/Assignee Checklist

[ ] This PR has an associated issue or issues.
[ ] The associated issue(s) are linked above.
[ ] This PR meets all acceptance criteria for those issues.
[ ] This PR and linked issue(s) are adequately documented
[ ] This PR and linked issues(s) are a complete description of the changeset; an individual or team should be able to understand the issue(s) and changes by reading through this PR and it's links, with no further interaction.

Enterprise-CMCS / macpro-quickstart-serverless