Closed ben-harvey closed 2 years ago
Code Climate has analyzed commit a3810da6 and detected 0 issues on this pull request.
The test coverage on the diff in this pull request is 100.0% (50% is the threshold).
This pull request will bring the total coverage in the repository to 25.9% (0.0% change).
View more on Code Climate.
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 thetests
folder.Bug Fixes
serverless
commands indev.ts
to fix errors encountered when running locallyupdateItem
callsed
command used inoutput.sh
that led to the last value in the YAML output byserverless info
being omittedboostrapUsersEnabled
in theui-auth
servicesh
inconfigure_local.sh
that fail on Linux machines withoutsh
installedsync
lambda to run without error if the parameters for GitHub repo/organization projects are not setCleanup and Reorganization
.sh
extension andsnake_case
scripts
foldertests
folder to remove nesting and duplicatepackage.json
/cypress.json
filesyarn
as a script runnerLinked Issues to Close
N/A
Approach
We tried to approach this as if we were a new user of the QuickStart, asking ourselves:
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
.sechub
servicePull Request Creator Checklist
Pull Request Reviewer/Assignee Checklist