Getting started - AWS
First steps
The following sections describe the setup process for the AWS IoT Framework repository. For more information head over to:
Introduction
The setup for the AWS IoT Framework is based around a Docker image which builds a capable development environment. In addition this Docker image can directly be hooked to a VS Code project, which enables an automatic work-space creation. This functionality is made possible through the Devcontainer capabilities of VS Code.
Setup process
- Make sure that Docker Desktop is installed on your system
- This repository is built around VS Code therefore make sure that it's installed on your system.
- Clone this repository and open it with VS Code
- Make sure that Docker Desktop is running
- VS Code should automatically detect that this repository contains a Dockerfile and launches the Docker container via the running Docker Desktop instance.
What's inside the container?
The image contains a fully capable Linux Debian distribution which has all the essential build tools for C++
and Python 3.9
pre-installed. In addition the stock BASH is replaced by a ZSH. The ZSH is then configured with the Oh My Zsh framework which enables a highly customizable shell environment.
Next the Dockerfile installs all necessary requirements for the development of AWS Lambdas and other Python
projects. The following modules are going to be installed:
- boto3
- awscli
- aws-sam-cli
- cfn-lint
- pandas
- matplotlib
- mkdocs-material
- mkdocs-plugin-mermaid
- mkdocs_pymdownx_material_extras
- mkdocs-git-revision-date-plugin
- mkdocstrings
Last but not least the devconatainer.json
settings and extensions are executed in order to install all necessary VS Code extensions within the Devcontainer.