feat: initial commit

Author: sliedig

README.md

@@ -1,17 +1,43 @@
-## My Project
+![AWS Serverless Developer Experience Workshop Reference Architecture](/docs/workshop_logo.png)
 
-TODO: Fill this README out!
+# AWS Serverless Developer Experience workshop reference architecture (Python)
 
-Be sure to:
+This repository contains the reference architecture for the AWS Serverless Developer Experience workshop.
 
-* Change the title in this README
-* Edit your repository description on GitHub
+The AWS Serverless Developer Experience workshop provides you with an immersive experience of a serverless developer. The goal is to provide you with an hands-on experience building a serverless solution using the [AWS Serverless Application Model (AWS SAM)](https://aws.amazon.com/serverless/sam/) and AWS SAM CLI.
 
-## Security
+Along the way, we want to demonstrate principles of event-driven distributed architecture, orchestration, and serverless observability, and how to apply them in code.
 
-See [CONTRIBUTING](CONTRIBUTING.md#security-issue-notifications) for more information.
+We'll also explore open-source tools, core features of AWS Lambda Powertools, and serverless CI/CD deployments. You can choose choose to run this workshop in a runtime of your choice — Python, TypeScript, Java, and .NET — and work with your own developer setup or use AWS Cloud9 to build the services.
 
-## License
+This workshop will take approximately 4 hours to complete. We are assuming that you have some practical development skills in one of the supported runtimes, and are familiar with some of the services that we will use in this solution which include: [Amazon API Gateway](https://aws.amazon.com/apigateway/), [AWS Lambda](https://aws.amazon.com/lambda/), [Amazon EventBridge](https://aws.amazon.com/eventbridge/), [AWS Step Functions](https://aws.amazon.com/step-functions/) and [Amazon DynamoDB](https://aws.amazon.com/dynamodb/).
 
-This library is licensed under the MIT-0 License. See the LICENSE file.
+## About the Architecture
 
+![AWS Serverless Developer Experience Workshop Reference Architecture](/docs/architecture.png)
+
+Our use case is based on a real estate company called **Unicorn Properties**.
+
+As a real estate agency, **Unicorn Properties** needs to manage the publishing of new property listings and sale contracts linked to individual properties, and provide a way for their customers to view approved property listings.
+
+To support their needs, Unicorn Properties have adopted a serverless, event-driven approach to designing their architecture. This architecture is centred around two primary domains: boundaries–Contracts (managed by the Contracts Service) and Properties (which are managed by the Properties Web and Properties Services).
+
+The **Contracts Service** is a simplified service that manages the contractual relationship between a seller of a property and Unicorn Properties. Contracts are drawn up that define the property for sale, the terms and conditions that Unicorn Properties sets, and how much it will cost the seller to engage the services of the agency.
+
+The **Properties Web** service manages the details of a property listing to be published on the Unicorn Properties website. Every property listing has an address, a sale price, a description of the property, and some photos that members of the public can look at to get them interested in purchasing the property. **Only properties that have been approved for publication can be made visible to the public**. 
+ 
+The **Properties Service** approves a listing. This service implements a workflow that checks for the existence of a contract, makes sure that the content and the images are safe to publish, and finally checks that the contract has been approved. We don’t want to publish a property until we have an approved contract! 
+
+
+## Credits
+
+Throughout this workshop we wanted to introduce you to some Open Source tools that can help you build serverless applications. This is not an exhaustive list, just a small selection of what we will be using in the workshop.
+
+Many thanks to all the AWS teams and community builders who have contributed to this list:
+
+| Tools                 | Description | Download / Installation Instructions |
+| --------------------- | ----------- | --------------------------------------- |
+| cfn-lint | Validate AWS CloudFormation yaml/json templates against the AWS CloudFormation Resource Specification and additional checks. | https://github.com/aws-cloudformation/cfn-lint |
+| cfn-lint-serverless | Compilation of rules to validate infrastructure-as-code templates against recommended practices for serverless applications. | https://github.com/awslabs/serverless-rules |
+| @mhlabs/iam-policies-cli| CLI for generating AWS IAM policy documents or SAM policy templates based on the JSON definition used in the AWS Policy Generator. | https://github.com/mhlabs/iam-policies-cli |
+| @mhlabs/evb-cli | Pattern generator and debugging tool for Amazon EventBridge | https://github.com/mhlabs/evb-cli |

contracts_service/.DS_Store

@@ -0,0 +1,2 @@
+[run]
+omit = tests/*

contracts_service/tests/.DS_Store

@@ -0,0 +1,84 @@
+### Linux ###
+**/*~
+**/.fuse_hidden*
+**/.directory
+**/.Trash-*
+**/.nfs*
+
+### OSX ###
+**/*.DS_Store
+**/.AppleDouble
+**/.LSOverride
+**/.DocumentRevisions-V100
+**/.fseventsd
+**/.Spotlight-V100
+**/.TemporaryItems
+**/.Trashes
+**/.VolumeIcon.icns
+**/.com.apple.timemachine.donotpresent
+
+### JetBrains IDEs ###
+**/*.iws
+**/.idea/
+**/.idea_modules/
+
+### Python ###
+**/__pycache__/
+**/*.py[cod]
+**/*$py.class
+**/.Python
+**/build/
+**/develop-eggs/
+**/dist/
+**/downloads/
+**/eggs/
+**/.eggs/
+**/parts/
+**/sdist/
+**/wheels/
+**/*.egg
+**/*.egg-info/
+**/.installed.cfg
+**/pip-log.txt
+**/pip-delete-this-directory.txt
+
+### Unit test / coverage reports ###
+**/.cache
+**/.coverage
+**/.hypothesis/
+**/.pytest_cache/
+**/.tox/
+**/*.cover
+**/coverage.xml
+**/htmlcov/
+**/nosetests.xml
+
+### pyenv ###
+**/.python-version
+
+### Environments ###
+**/.env
+**/.venv
+**/env/
+**/venv/
+**/ENV/
+**/env.bak/
+**/venv.bak/
+
+### VisualStudioCode ###
+**/.vscode/
+**/.history
+
+### Windows ###
+# Windows thumbnail cache files
+**/Thumbs.db
+**/ehthumbs.db
+**/ehthumbs_vista.db
+**/Desktop.ini
+**/$RECYCLE.BIN/
+**/*.lnk
+
+### requirements.txt ###
+# We ignore Python's requirements.txt as we use Poetry instead
+**/requirements.txt
+**/.aws-sam

contracts_service/tests/.coverage

@@ -0,0 +1,35 @@
+stackName := uni-prop-local-contract
+
+build:
+	cfn-lint template.yaml -a cfn_lint_serverless.rules
+	poetry export --without-hashes --format=requirements.txt --output=src/requirements.txt
+	sam build -c
+
+deps:
+	poetry install
+
+deploy: build
+	sam deploy --no-confirm-changeset
+
+sync:
+	sam sync --stack-name $(stackName) --watch
+
+test: unit-test
+
+unit-test: deps
+	poetry run pytest tests/unit/
+
+integration-test: deps
+	AWS_SAM_STACK_NAME=$(stackName) poetry run pytest tests/integration/
+
+logs:
+	sam logs --stack-name $(stackName) -t
+
+clean:
+	find . -type d -name __pycache__ -exec rm -rf {} \; 2>/dev/null || true
+	find . -type f -name requirements.txt -exec rm -f {} \; 2>/dev/null || true
+	rm -rf .pytest_cache/ .aws-sam/ htmlcov/ .coverage || true
+
+delete:
+	sam delete --stack-name $(stackName) --no-prompts
+

contracts_service/tests/unit/.coverage

@@ -0,0 +1,14 @@
+# Unicorn Properties: Contracts Service
+
+## Overview
+
+TODO: add overview
+
+TODO: add architecture image
+
+## Testing with Postman
+
+TODO: add instructions
+
+## Testing with TODO: curl or httpie
+