Skip to content

Commit

Permalink
Update DEVELOPER.md
Browse files Browse the repository at this point in the history
  • Loading branch information
kuettai authored Aug 13, 2024
1 parent 987ddd3 commit 94a6612
Showing 1 changed file with 25 additions and 9 deletions.
34 changes: 25 additions & 9 deletions DEVELOPER.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,30 @@
# Service Screener Developer Guide

## Preparation on Mac environment
```bash

## Install homebrew
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
# PLEASE READ
# FOLLOW THE 'NEXT STEP' shows after installation
# THERE ARE 2 COMMANDS TO COPY/PASTE to set the environment variables correctly

## Install Python, and set the alias in ~/.zprofile or ~/.bash_profile
brew install [email protected]
which python3.12
alias python3=... <to the path above>, #also setup this in ~/.zprofile?

## Install AWS CLI
curl "https://awscli.amazonaws.com/AWSCLIV2.pkg" -o "AWSCLIV2.pkg"
sudo installer -pkg AWSCLIV2.pkg -target /

# Setup AWS Profile
aws configure --profile ss

## When executing SS locally
screener --regions ap-southeast-1 --profile ss
```

## Pre-requisite
1. git account
1. fork the master repository from aws-samples
Expand All @@ -8,12 +33,3 @@
1. Setup necessary IAM Users with readOnly permission.
1. Generate Accesskey & Secret combination to be used by local machine
1. Run ```aws configure --profile <name>``` and follow through the setup wizard

## Preparation on Mac environment
```bash
# You may opt-in to develop in other PHP version, the following guide is to
brew install [email protected]
php -v # make sure it is version 7.4

## Then you may follow the official instruction to install composer & php-sdk
```

0 comments on commit 94a6612

Please sign in to comment.