Environment Setup

Backend devs should have the following installed and configured as described below:

Install Python 3.x

Windows

1. Download the Python installer package from the official Python website
2. It should detect your operating system and show a yellow download button. If it doesn’t, click the windows link and choose the latest Python release.
3. Once the download is complete, double-click the package to start installing Python. Follow the installation steps with the default settings.
4. Once installation is complete, you have python installed on your system!

To check if it is installed correctly:

py --version
# Python 3.10.7

info

If you have installed Python through the Microsoft Store, replace py with python in the command above.

macOS

1. Download the Python installer package from the official Python website
2. It should detect your operating system and show a yellow download button. If it doesn’t, click the macos link and choose the latest Python release.
3. Once the download is complete, double-click the package to start installing Python. Follow the installation steps with the default settings.
4. Once installation is complete, you have python installed on your system!

To check if it is installed correctly:

python --version
# Python 3.10.7

Linux

Ubuntu

deadsnakes PPA contains more recent Python versions packaged for Ubuntu.

$ sudo apt-get install software-properties-common
$ sudo add-apt-repository ppa:deadsnakes/ppa
$ sudo apt-get update
$ sudo apt-get install python3.8

Other Linux distribution

If you are using other Linux distribution, Python 3 is most likely preinstalled. If not, use your distribution's package manager to install it.

For example, on Fedora, you would use dnf:

$ sudo dnf install python3

And on ArchLinux, you would use pacman:

$ sudo pacman -S python

To check if it is installed correctly:

python --version
# Python 3.10.7

Install poetry

The installer script is available directly at install.python-poetry.org. The script can be executed directly (i.e. curl python) or downloaded and then executed from disk (e.g. in a CI environment).

Windows

Step 1. Install Poetry

Run the following with PowerShell

(Invoke-WebRequest -Uri https://install.python-poetry.org -UseBasicParsing).Content | py -

info

If you have installed Python through the Microsoft Store, replace py with python in the command above.

Step 2. Add Poetry to your PATH

The installer creates a poetry wrapper in %APPDATA%\Python\Scripts on Windows.

If this directory is not present in your $PATH, you can add it in order to invoke Poetry as poetry.

Step 3. Use Poetry

Once Poetry is installed and in your $PATH, you can execute the following

poetry --version

macOS

Step 1. Install Poetry

Run the following with bash

curl -sSL https://install.python-poetry.org | python3 -

Step 2. Add Poetry to your PATH

The installer creates a poetry wrapper in

• $HOME/.local/bin on Unix
• $POETRY_HOME/bin if $POETRY_HOME is set.

If this directory is not present in your $PATH, you can add it in order to invoke Poetry as poetry (zshrc/bash_profile).

Step 3. Use Poetry

Once Poetry is installed and in your $PATH, you can execute the following

poetry --version

Linux

Step 1. Install Poetry

Run the following with bash

curl -sSL https://install.python-poetry.org | python3 -

Step 2. Add Poetry to your PATH

The installer creates a poetry wrapper in

• $HOME/.local/bin on Unix
• $POETRY_HOME/bin if $POETRY_HOME is set.

If this directory is not present in your $PATH, you can add it in order to invoke Poetry as poetry (zshrc/bash_profile).

Step 3. Use Poetry

Once Poetry is installed and in your $PATH, you can execute the following

poetry --version

Install nvm & node.js

Follow the instructions to install nvm & node.js here

Reminder

Use nvm to switch between versions of node.js across projects

Install serverless cli

Install the serverless CLI via NPM:

npm install -g serverless

That's all!

Install dynamodb offline

DynamoDB will be run locally using the serverless-dynamodb-local plugin.

The serverless-dynamodb-local plugin requires

• serverless@^1 (installed in the previous step)
• Java Runtime Engine (JRE) version 6.x

1. Install plugin

   npm install --save serverless-dynamodb-local

2. Then in serverless.yml add following entry to the plugins array: serverless-dynamodb-local

   plugins:
     - serverless-dynamodb-local

3. Install DynamoDB locally

   sls dynamodb install

4. Run DynamoDB locally

   sls dynamodb start

   This starts the DynamoDB Local instance as a local Java program (default: http://localhost:8000)