# Developer Onboarding ## Pre-Requisites * [AWS CLI v2](https://docs.aws.amazon.com/cli/latest/userguide/getting-started-install.html) * [Python3](https://www.python.org/downloads/) + [PyEnv](https://github.com/pyenv/pyenv) * [nvm](https://github.com/nvm-sh/nvm) * [yarn](https://yarnpkg.com/) * [Git](https://git-scm.com/downloads) {% hint style="warning" %} ## Versions Replace the variables in the code snippets below with the following values: * PYTHON\_VERSION: 3.9.18 * NODEJS\_VERSION: 16.3.0 * CDK\_VERSION: 2.95.1 {% endhint %} ## Prepare environment ### **Python <**PYTHON\_VERSION> ```bash pyenv install --skip-existing $PYTHON_VERSION ``` ### **NodeJS \** ```bash nvm install $NODEJS_VERSION nvm use $NODEJS_VERSION ``` #### **AWS CDK \** {% hint style="danger" %} **Note:** Do **NOT** install CDK globally using `npm -g` or `yarn global add` {% endhint %} Follow the instructions below: ```bash mkdir -p ~/.idea/lib/idea-cdk && pushd ~/.idea/lib/idea-cdk npm init --force --yes npm install aws-cdk@$CDK_VERSION --save popd ``` {% hint style="info" %} If you want to **upgrade** CDK version for your existing IDEA dev environment, run: ```bash invoke devtool.upgrade-cdk ``` {% endhint %} #### **Docker Desktop (Optional)** Follow instructions on the below link to install Docker Desktop. (Required if you are working with creating Docker Images) ## Clone Git Repo All CRs will be accepted only against the main branch. ```bash git clone https://github.com/awslabs/integrated-digital-engineering-on-aws.git cd integrated-digital-engineering-on-awsb // make your changes ``` ## Virtual Environment Activate your python virtual environment via: ```bash PYENV_VERSION=$PYTHON_VERSION python -m venv venv source venv/bin/activate ``` If your PYENV\_VERSION command is not working for any reason, you can create venv using below command: ```bash $HOME/.pyenv/versions/$PYTHON_VERSION/bin/python3 -m venv venv ``` ## Install Dev Requirements ```bash pip install -r requirements/dev.txt ```
Note for MacOS users ***BigSur Note:*** cryptography and orjson library requirements fail to install on MacOS BigSur.
To fix **cryptography**, follow the instructions mentioned here:\ ``` env LDFLAGS="-L$(brew --prefix openssl@1.1)/lib" CFLAGS="-I$(brew --prefix openssl@1.1)/include" pip install cryptography==36.0.1 ``` To fix **orjson**, run: ``` brew install rust # Upgrade your pip python3 -m pip install --upgrade pip ```
## Verify Dev Setup Run below command to check if development environment is working as expected, run: ```bash invoke -l ``` Running this command should print output like below: 
Available tasks:

admin.main (admin)                   call administrator app main
build.administrator                  build administrator
build.all (build)                    build all
build.cluster-manager                build cluster manager
build.data-model                     build data-model
build.dcv-connection-gateway         build dcv connection gateway
build.scheduler                      build scheduler
build.sdk                            build sdk
build.virtual-desktop-controller     build virtual desktop controller
clean.administrator                  clean administrator
clean.all (clean)                    clean all components
clean.cluster-manager                clean cluster manager
clean.data-model                     clean data-model
clean.dcv-connection-gateway         clean dcv connection gateway
clean.scheduler                      clean scheduler
clean.sdk                            clean sdk
clean.virtual-desktop-controller     clean virtual desktop controller
devtool.build                        wrapper utility for invoke clean.\ build.\ package.\
devtool.configure                    configure devtool
devtool.ssh                          ssh into the workstation
devtool.sync                         rsync local sources with remote development server
devtool.upload-packages              upload packages
docker.build                         build administrator docker image
docker.prepare-artifacts             copy administrator docker image artifacts to deployment dir
docker.print-commands                print docker push commands for ECR
package.administrator                package administrator
package.all (package)                package all components
package.cluster-manager              package cluster manager
package.dcv-connection-gateway       package dcv connection gateway
package.scheduler                    package scheduler
package.virtual-desktop-controller   package virtual desktop controller
release.prepare-opensource-package
release.update-version
req.install                          Install python requirements
req.update                           Update python requirements using pip-compile.
scheduler.cli (scheduler)            call scheduler cli
tests.run-integration-tests          Run Integration Tests
tests.run-unit-tests                 Run Unit Tests
web-portal.serve                     serve web-portal frontend app in web-browser
web-portal.typings                   convert idea python models to typescript
## Clean, Build and Package ```bash invoke clean build package ``` ## Run idea-admin.sh in Developer Mode The **IDEA\_DEV\_MODE** environment variable is used to indicate if *idea-admin.sh* should use the Docker Image or Run from sources. * If IDEA\_DEV\_MODE=true, idea-admin.sh will execute administrator app directly using sources. * If IDEA\_DEV\_MODE=false (default), idea-admin.sh will attempt to download the docker image for the latest release version and execute administrator app using Docker Container. Export `IDEA_DEV_MODE=true` on your terminal, before executing idea-admin.sh on from project root. 
# Enable Dev Mode
export IDEA_DEV_MODE=true
You will need to run **export IDEA\_DEV\_MODE=true**, each time you open a new Terminal session. #### Verify if Developer Mode is enabled To verify, if Developer Mode is enabled, run below command. This should print **(Developer Mode)** at the end of the banner. 
./idea-admin.sh about

'####:'########::'########::::'###::::
. ##:: ##.... ##: ##.....::::'## ##:::
: ##:: ##:::: ##: ######:::'##:::. ##:
: ##:: ##:::: ##: ##...:::: #########:
'####: ########:: ########: ##:::: ##:

Integrated Digital Engineering on AWS
Version 3.0.0-beta.1
(Developer Mode)
--- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://docs.ide-on-aws.com/idea/developer-portal/developer-onboarding.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.