Developer Tips

VSCode Settings

Compare your .vscode/settings.json and .vscode/settings.default.json

Extensions

.vscode/extensions.json should cause VScode to prompt you to install the recommended extensions for this project.

Bash Aliases

You may want to create ~/.bash_aliases similar to this for quick reefguide development commands. These quickly get you to the most used directories and run common developer commands.

export REEFGUIDE_REPO="${HOME}/code/reefguide"

alias rg-cd="cd $REEFGUIDE_REPO"
alias rg-ng="cd $REEFGUIDE_REPO/packages/app && ng serve"
alias rg-api="cd $REEFGUIDE_REPO && turbo watch api"
alias rg-ld="cd $REEFGUIDE_REPO && ./local-dev.sh"
alias rg-db="cd $REEFGUIDE_REPO/packages/db && npx prisma migrate status"

alias rg-infra-test="cd $REEFGUIDE_REPO/packages/infra && . ./configs/test_env.sh"
alias rg-infra-prod="cd $REEFGUIDE_REPO/packages/infra && . ./configs/prod_env.sh"

You’ll need to create the above *_env.sh files with the environment variables for infra.

export CONFIG_FILE_NAME=test.json
export AWS_DEFAULT_REGION=ap-southeast-2
export AWS_PROFILE=rrapopsbuildpoweruser
export PORT_FWD_HOST="test-reefguide-dbinstanceXXXXX.YYYYY.ap-southeast-2.rds.amazonaws.com"
export PORT_FWD_PORT=5432
export PORT_FWD_LOCALPORT=25432

Note: you will also need to authenticate with AWS: aws sso login