Skip to content

Commit 6b09588

Browse files
Update file Developer Environment Guide for Linux.md
1 parent 9dddb28 commit 6b09588

File tree

1 file changed

+32
-37
lines changed

1 file changed

+32
-37
lines changed

docs/Developer Environment Guide for Linux.md

Lines changed: 32 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -56,37 +56,20 @@ Click Launch instance and wait for it to reach "Running" state.
5656
1. Select your instance in EC2 console
5757
2. Note the Public IPv4 address
5858

59-
#SSH Connection Command
59+
# SSH Connection Command
6060
On local machine:
61-
```bash
6261
# CMD Terminal
6362
ssh -i /path/to/genai-idp-dev-key.pem ec2-user@YOUR_INSTANCE_IP
64-
or
65-
# PowerShell:
66-
ssh -i C:\path\to\genai-idp-dev-key.pem ec2-user@YOUR_INSTANCE_IP
67-
```
68-
## Step 3: Automated Setup Script
69-
70-
# Introduction:
71-
For faster setup, you can use this automated script that installs all required development tools in one go. This
72-
script configures Python 3.12, AWS CLI, SAM CLI, Node.js, Docker, and development tools with optimized settings.
73-
What it installs: Complete development stack including Python 3.13, AWS CLI v2, SAM CLI, Node.js 18, Docker,
74-
Miniconda, and enhanced shell configuration.
75-
Usage: Copy the script below, save it as setup.sh, make it executable with chmod +x setup.sh, and run ./setup.sh.
76-
Reboot required after completion.
77-
78-
Note: This script is an alternative to the manual installation steps.
7963

80-
./scripts/dev_setup.sh
81-
```bash
82-
# Navigate to the project directory
83-
cd /home/ec2-user/genaiic-idp-accelerator
64+
# Clone Repository
65+
bash
66+
git clone https://github.com/aws-solutions-library-samples/accelerated-intelligent-document-processing-on-aws
8467

8568
# Run the setup script
86-
./scripts/dev_setup.sh
69+
./dev_setup.sh
8770

8871
## Step 4: Install Visual Studio Code
89-
Visit the official website: Go to [https://code.visualstudio.com/](https://code.visualstudio.com/)
72+
# 4.1 Visit the official website: Go to [https://code.visualstudio.com/](https://code.visualstudio.com/)
9073
Download: Click the "Download for Windows" button
9174
• This will download the User Installer (recommended for most users)
9275
• File name will be something like VSCodeUserSetup-x64-1.x.x.exe
@@ -95,11 +78,9 @@ Install:
9578
• Choose installation location (default is recommended)
9679
Launch: Click "Launch Visual Studio Code" when installation completes
9780

98-
VSCode setup
99-
1. Open VSCode on your local computer
100-
2. Install Remote - SSH extension (by Microsoft)
81+
Install Remote - SSH extension (by Microsoft)
10182

102-
### 4.2 Connect via VSCode: Update your SSH config
83+
# 4.2 Connect via VSCode: Update your SSH config
10384
Press Ctrl+Shift+P for commands
10485
Append the following block to your ~/.ssh/config file:
10586

@@ -111,17 +92,11 @@ Host genai-idp-dev
11192
Port 22
11293
```
11394

114-
# Clone Repository
115-
bash
116-
git clone https://github.com/aws-samples/genaiic-idp-accelerator.git
117-
cd genaiic-idp-accelerator
118-
119-
12095
# 4.3 Connect via VSCode
12196
1. Press Ctrl+Shift+P
12297
2. Type "Remote-SSH: Connect to Host"
12398
3. Select "genai-idp-dev"
124-
4. Open folder: /home/ec2-user/genaiic-idp-accelerator
99+
4. Open folder: /home/ec2-user//accelerated-intelligent-document-processing-on-aws
125100

126101
## Step 5: Setup
127102

@@ -131,11 +106,31 @@ cd genaiic-idp-accelerator
131106
python3 -m venv venv
132107
source venv/bin/activate
133108

109+
## Step6: Configure
110+
For aws configure you need "access key" and "secret access key"
111+
If you have one use that or create access key
112+
1.In the AWS Console search bar, type "IAM"
113+
Click on "IAM" service
114+
2.In the left sidebar, click "Users"
115+
Find and click on your username
116+
Click on the "Security credentials" tab
117+
Scroll down to "Access keys" section
118+
3. Click "Create access key"
119+
4. Choose use case:
120+
**"Command Line Interface (CLI)"** - for development
121+
**"Local code"** - for applications
122+
5. Click "Next"
123+
6. Add description (optional): "Development Environment"
124+
7. Click "Create access key"
125+
8.Click "Download .csv file" to save both keys
126+
```bash
127+
aws configure
128+
134129
### Test Build Process
135130
```bash
136131
# Test publish script help
137-
./scripts/publish.sh --help
132+
./publish.sh --help
138133

139134
# Test build (this will take 10-15 minutes)
140-
./scripts/publish.sh --build-only --region us-east-1
141-
```
135+
./publish.sh bucket_name build-test us-east-1
136+
```

0 commit comments

Comments
 (0)