Skip to content

LOCAL_DEVELOPMENT.md

Latest commit

 

History

History
64 lines (49 loc) · 1.74 KB

LOCAL_DEVELOPMENT.md

File metadata and controls

64 lines (49 loc) · 1.74 KB

Local Development

This section details how to run the solution locally and deploy your code changes from the command line.

Pre-Requisites

The following dependencies must be installed:

  • Python >=3.12 and pip
  • virtualenv
  • AWS CLI configured with appropriate credentials

Build local development environment

Once you have installed pre-requisites, you must run the following commands to create a virtualenv and install all dependencies before commencing development.

Note: This project is currently being updated to Python 3.13, SQL Server 2022, Windows Server 2022 AMI, and 6th generation EC2/RDS instances (M6i, C6i) for improved performance and security.

  1. Create a S3 bucket

    BUCKET_NAME="your-s3-bucket-name"
AWS_REGION="aws-region(e.g. us-east-1)"
aws s3 mb s3://${BUCKET_NAME} --region $AWS_REGION

  2. Create a .custom.mk file and populate it with your own values

    cp .custom.mk.example .custom.mk

  3. Initialize the local environment

    make init

  4. Activate virtualenv environment.

    source venv/bin/activate

Deploy the stack

To deploy the solution manually from the source to your AWS account, run the following:

make deploy

This will deploy the nested stack using the AWS CLI profile of the current shell. By default this will be the profile default.

Test changes

The following command will run pre-commit tests. This should be run before every new commit.

make test

Clean the virtual environment

This command will delete the virtual environment and all installed packages install via make init

make clean

Delete the resources created via CloudFormation

Below command will delete deployed stack

make delete