Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/katherinemc2/qr-generator
Serverless QR Code Generator
https://github.com/katherinemc2/qr-generator
aws-apigateway aws-cdk aws-dynamodb aws-eventbridge aws-lambda aws-s3
Last synced: 9 days ago
JSON representation
Serverless QR Code Generator
- Host: GitHub
- URL: https://github.com/katherinemc2/qr-generator
- Owner: KatherineMC2
- Created: 2024-09-11T19:58:21.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2024-10-07T11:47:58.000Z (3 months ago)
- Last Synced: 2024-11-06T12:34:45.958Z (about 2 months ago)
- Topics: aws-apigateway, aws-cdk, aws-dynamodb, aws-eventbridge, aws-lambda, aws-s3
- Language: Python
- Homepage:
- Size: 145 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Serverless QR Code Generator
Generate QR Codes from your favourite URLS, made completely with AWS Serverless with AWS CDK in an event driven architecture.
# Services Used:
API Gateway, AWS Lambda, Amazon S3,Amazon DynamoDB, Amazon EventBridge, Amazon CloudFront
# Architecture:
Architecture as of now:
## Blog
To discover how was made visit my [blog](https://katherinemoreno.me/blog/qr-code-generator/ )
# Pre Requisites
1. Poetry
This project uses poetry as dependency manager
* [Installation](https://python-poetry.org/docs/#installing-with-pipx)
* [Tutorial](https://realpython.com/dependency-management-python-poetry/)
* [Known Errors](./docs/poetry.md)
2. Docker
* [Installation](https://docs.docker.com/get-docker/)
# Scripts
```
poetry run cdk deploy Deploy the CDK Stack
poetry run cdk synth Synth Stack
poetry run cdk destroy Destroy the CDK Stack
poetry run ruff check --diff Checks if lint is correct
poetry run ruff check --fix Checks if lint is correct and if it is not tries to fix it
poetry run ruff format --check Checks if formatting is correct
poetry run ruff format Check if formatting is correct and if it is not tries autoformat it
```
# Welcome to your CDK Python project!
This is a blank project for CDK development with Python.
The `cdk.json` file tells the CDK Toolkit how to execute your app.
This project is set up like a standard Python project. The initialization
process also creates a virtualenv within this project, stored under the `.venv`
directory. To create the virtualenv it assumes that there is a `python3`
(or `python` for Windows) executable in your path with access to the `venv`
package. If for any reason the automatic creation of the virtualenv fails,
you can create the virtualenv manually.
To manually create a virtualenv on MacOS and Linux:
```
$ python -m venv .venv
```
After the init process completes and the virtualenv is created, you can use the following
step to activate your virtualenv.
```
$ source .venv/bin/activate
```
If you are a Windows platform, you would activate the virtualenv like this:
```
% .venv\Scripts\activate.bat
```
Once the virtualenv is activated, you can install the required dependencies.
```
$ pip install -r requirements.txt
```
At this point you can now synthesize the CloudFormation template for this code.
```
$ cdk synth
```
To add additional dependencies, for example other CDK libraries, just add
them to your `setup.py` file and rerun the `pip install -r requirements.txt`
command.
to install dependencies of the layer do from the root folder execute the command
```
pip install -t ./layer -r requirements.txt
```
## Useful commands
* `cdk ls` list all stacks in the app
* `cdk synth` emits the synthesized CloudFormation template
* `cdk deploy` deploy this stack to your default AWS account/region
* `cdk diff` compare deployed stack with current state
* `cdk docs` open CDK documentation
Enjoy!