Skip to content

Commit cde29e2

Browse files
committedApr 14, 2023
Add .devcontainer and update README.md
1 parent 147f243 commit cde29e2

File tree

2 files changed

+36
-0
lines changed

2 files changed

+36
-0
lines changed
 

‎.devcontainer/devcontainer.json

+22
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
// For format details, see https://aka.ms/devcontainer.json. For config options, see the
2+
// README at: https://github.com/devcontainers/templates/tree/main/src/typescript-node
3+
{
4+
"name": "AgentGPT",
5+
// Or use a Dockerfile or Docker Compose file. More info: https://containers.dev/guide/dockerfile
6+
"image": "mcr.microsoft.com/devcontainers/typescript-node:0-18"
7+
8+
// Features to add to the dev container. More info: https://containers.dev/features.
9+
// "features": {},
10+
11+
// Use 'forwardPorts' to make a list of ports inside the container available locally.
12+
// "forwardPorts": [],
13+
14+
// Use 'postCreateCommand' to run commands after the container is created.
15+
// "postCreateCommand": "yarn install",
16+
17+
// Configure tool-specific properties.
18+
// "customizations": {},
19+
20+
// Uncomment to connect as root instead. More info: https://aka.ms/dev-containers-non-root.
21+
// "remoteUser": "root"
22+
}

‎README.md

+14
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,20 @@ More Coming soon...
6969

7070
## 👨‍🚀 Getting Started
7171

72+
### 🚀 GitHub Codespaces
73+
74+
The easiest way to run AgentGPT immediately is by using [GitHub Codespaces](https://github.com/features/codespaces).
75+
76+
1. From the GitHub repo, click the green "Code" button and select "Codespaces".
77+
2. Create a new Codespace or select a previous one you've already created.
78+
3. Codespaces opens in a separate tab in your browser.
79+
4. In terminal, run `bash ./setup.sh --local`
80+
5. When prompted in terminal, add your OpenAI API key.
81+
6. Click "Open in browser" when the build process completes.
82+
83+
- To shut AgentGPT down, enter Ctrl+C in Terminal.
84+
- To restart AgentGPT, run `npm run dev` in Terminal.
85+
7286
### 🐳 Docker Setup
7387

7488
The easiest way to run AgentGPT locally is by using docker.

0 commit comments

Comments
 (0)
Please sign in to comment.