Updated documentation, restructured directory and refined serverless functions

Signed-off-by: Leamsi9 <ismaelv.dev@gmail.com>

Author: Leamsi9

.gitignore

@@ -37,13 +37,13 @@ BLO2023_normalised_migration_2023_03_15.sql
 BLO2018_legacy_migration_2023_03_15.sql
 
 #amplify-do-not-edit-begin
-amplify/\#current-cloud-backend
-amplify/.config/local-*
-amplify/logs
-amplify/mock-data
-amplify/mock-api-resources
-amplify/backend/amplify-meta.json
-amplify/backend/.temp
+blo-backend/amplify/\#current-cloud-backend
+blo-backend/amplify/.config/local-*
+blo-backend/amplify/logs
+blo-backend/amplify/mock-data
+blo-backend/amplify/mock-api-resources
+blo-backend/amplify/backend/amplify-meta.json
+blo-backend/amplify/backend/.temp
 build/
 dist/
 node_modules/

.graphqlconfig.yml

@@ -1,15 +1,16 @@
 projects:
-  BLOApi:
-    schemaPath: blo-app/src/graphql/schema.json
+  bloapi:
+    schemaPath: >-
+      ./blo-frontend/src/graphql/schema.json
     includes:
-      - blo-app/src/graphql/**/*.js
+      - ./blo-frontend/src/graphql/**/*.js
     excludes:
-      - ./amplify/**
+      - .//blo-backend/aws/amplify/**
     extensions:
       amplify:
         codeGenTarget: javascript
         generatedFileName: ''
-        docsFilePath: blo-app/src/graphql
+        docsFilePath: ./blo-frontend/src/graphql/
 extensions:
   amplify:
     version: 3

README.md

@@ -38,9 +38,9 @@ Phase 1 of work has involved the following:
    - Validate architectural design concepts and AWS service orchestration choices in consultation with 4 AWS experts and solution architects over multiple meetings
    - Design and plan graceful failure and redundancy strategies
    - Design and plan a serverless API
-3. Foundational data layer design (see [API docs](./documentation/data_layer/api_design/))
+3. Foundational data layer design (see [API docs](documentation/api_design/))
 
-![api design](documentation/data_layer/api_design/Data%20structure.png)
+![api design](documentation/api_design/Data%20structure.png)
 
    - Design a preliminary data structure for the planned API
    - Draft an OpenAPI contract to enable API First design
@@ -58,7 +58,7 @@ Infrastructure setup
    - Set up final S3 and Cloudfront static website
    - Set up public Github repository
    - Created a [docker-compose specification](docker-compose.yml) to run the legacy BLO mysql database locally
-   - Provision an [Amplify backend](amplify/) including DynamoDB database and graphQL API
+   - Provision an [Amplify backend](blo-backend/amplify/) including DynamoDB database and graphQL API
 
 ### Operational implementation work to date
 The following implementation has been completed, additionally to from the architectural and technical planning and infrastructure set-up: 
@@ -67,12 +67,12 @@ The following implementation has been completed, additionally to from the archit
    - Mirror & scrape >100,000 urls via httrack over several weeks while 1-3 proceeds iteratively
    - Upload the above data to an S3 bucket via the PUT API and expose it publicly as [a transitional but functional BLO website clone](https://bahai-library-online.s3.eu-north-1.amazonaws.com/index.html).
    - Expose new static site via CloudFront (https://bahai-library-online.s3.eu-north-1.amazonaws.com/index.html)
-2. Legacy [mysql database migration, redesign and normalisation](documentation/data_layer/databases/mysql/)
-3. Conversion and [export of normalised MYSQL database data to DynamoDB document store](documentation/data_layer/databases/mysql/BLO2023_normalised/exportMysqlToDynamoDB.js).
-3. Draft [OpenApi specification](documentation/data_layer/api_design/blo_openapi.json) as an option
+2. Legacy [mysql database migration, redesign and normalisation](blo-backend/databases/mysql/)
+3. Conversion and [export of normalised MYSQL database data to DynamoDB document store](blo-backend/databases/mysql/BLO2023_normalised/exportMysqlToDynamoDB.js).
+3. Draft [OpenApi specification](documentation/api_design/blo_openapi.json) as an option
 3. Preliminary Serverless Application Model template for provisioning APIGateway. Considering Serverless Framework as an alternative that makes possible carbon aware computing patterns in future.
-4. [GraphQL specification](documentation/data_layer/api_design/blo2023_amplify_schema.graphql) for use with AWS Amplify with a [DynamoDB back end](documentation/data_layer/databases/dynamodb/)
-5. Prototype [React upload form for a new BLO metadata app](blo-app) powered by GraphQL API and DynamoDB backend
+4. [GraphQL specification](documentation/api_design/blo2023_amplify_schema.graphql) for use with AWS Amplify with a [DynamoDB back end](blo-backend/databases/dynamodb/)
+5. Prototype [React upload form for a new BLO metadata app](frontend) powered by GraphQL API and DynamoDB backend
 6. Coded and provisioned transitional [serverless Lambda function](serverless-functions) to be able to use the legacy BLO edit functionality to add new materials and have the rendered page added to the S3 static clone until the new app is fully functional
 
 ### Documentation work to date