DeployFrame Docs
Prerequisites

Development Environment Setup

Installing and configuring the necessary tools for developing and deploying the AI SaaS Boilerplate with Python CDK

Development Environment Setup

This guide will help you set up a development environment with all the necessary tools for working with the AI SaaS Boilerplate, focusing on the Python-based AWS CDK implementation.

Required Tools

Here's a summary of the tools you'll need to install:

ToolVersionPurpose
Python3.8+Core programming language for CDK implementation
pipLatestPython package manager
AWS CLIv2.x+Command-line interface for AWS services
AWS CDKv2.x+Cloud Development Kit for infrastructure deployment
GitLatestVersion control system for code management
Node.jsv20.x+Required for frontend development
npmLatestNode.js package manager
DockerLatestRequired for building containerized Lambda functions

Installation Instructions

Install Python, pip, and venv

Using Homebrew:

brew install python

Python virtual environments are included with the Python installation on macOS.

Verify the installation:

python3 --version
pip3 --version

Install Node.js and npm

Using Homebrew:

brew install node

Verify the installation:

node --version
npm --version

npm is installed automatically with Node.js, but it's good to verify both installations.

Install Docker

Install Docker Desktop for macOS:

  1. Download Docker Desktop from Docker's website
  2. Follow the installation instructions
  3. Start Docker Desktop

Verify the installation:

docker --version
docker run hello-world

Install AWS CLI

Using Homebrew:

brew install awscli

Verify the installation:

aws --version

Install AWS CDK

Using npm:

npm install -g aws-cdk

Verify the installation:

cdk --version

Install Git

Using Homebrew:

brew install git

Verify the installation:

git --version

Configuring AWS CLI

After installing the AWS CLI, you need to configure it with your AWS credentials obtained from the AWS Account Setup step.

Run AWS Configure

Open a terminal or command prompt and run:

aws configure

Enter Your Credentials

You'll be prompted to enter:

  • AWS Access Key ID: Enter the access key ID from your IAM user
  • AWS Secret Access Key: Enter the secret access key from your IAM user
  • Default region name: Enter 'eu-west-2' (London region)
  • Default output format: Enter 'json'

These are the credentials you obtained when creating an IAM user in the AWS Account Setup step.

Verify the Configuration

To verify that your AWS CLI is configured correctly, run:

aws sts get-caller-identity

This should return a JSON response with your account ID, user ID, and ARN, confirming that your AWS CLI is properly configured.

Example output:

{
    "UserId": "AIDAXXXXXXXXXXXX",
    "Account": "123456789012",
    "Arn": "arn:aws:iam::123456789012:user/ai-saas-admin"
}

Verifying Your Environment

After installing and configuring all the required tools, verify that everything is working correctly:

python --version        # Should show Python 3.8 or higher
pip --version           # Should show the pip version
node --version          # Should show v20.x or higher
npm --version           # Should show the npm version
docker --version        # Should show the Docker version
aws --version           # Should show aws-cli/2.x.x
cdk --version           # Should show the CDK version
git --version           # Should show the Git version

Next Steps

Now that you've set up your development environment with all the necessary tools and configured AWS CLI with your credentials, you're ready to proceed to Configuration to set up your environment for deployment.

Previous

AWS Account Setup

Next

Configuration

On this page