From 94a66127a2a64f35deea3295b05a56683def5c1a Mon Sep 17 00:00:00 2001 From: KuetTai Date: Tue, 13 Aug 2024 17:21:20 +0800 Subject: [PATCH] Update DEVELOPER.md --- DEVELOPER.md | 34 +++++++++++++++++++++++++--------- 1 file changed, 25 insertions(+), 9 deletions(-) diff --git a/DEVELOPER.md b/DEVELOPER.md index 45d91af..905469c 100644 --- a/DEVELOPER.md +++ b/DEVELOPER.md @@ -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 python@3.12 +which python3.12 +alias python3=... , #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 @@ -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 ``` 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 php@7.4 -php -v # make sure it is version 7.4 - -## Then you may follow the official instruction to install composer & php-sdk -``` \ No newline at end of file