Skip to content

Commit

Permalink
☝️ Update README.md (#865)
Browse files Browse the repository at this point in the history
  • Loading branch information
jasangill1 committed Jun 27, 2023
1 parent d0c6b77 commit 16657f4
Showing 1 changed file with 33 additions and 12 deletions.
45 changes: 33 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,18 +44,39 @@ The cli sets up the following for AgentGPT:
- 🤖 [Backend](https://github.com/reworkd/AgentGPT/tree/main/platform) (FastAPI)
- 🎨 [Frontend](https://github.com/reworkd/AgentGPT/tree/main/next) (Nextjs)

- You will need node intalled, you can check by running 'node -v' or install [node](https://nodejs.org/en/download)

To get started on Mac/Linux, run the commands below.
```bash
git clone https://github.com/reworkd/AgentGPT.git && cd AgentGPT
./setup.sh
```
If you are on windows, you can do the following after downloading the repo.
```
setup.bat
```
> 🐳 The recommend way to set up AgentGPT locally is to [docker-compose](https://www.docker.com/), please make sure you have docker installed.
## Prerequisites :point_up:

Before you get started, please make sure you have the following installed:

- An editor of your choice. For example, [Visual Studio Code (VS Code)](https://code.visualstudio.com/download)
- [Node.js](https://nodejs.org/en/download)
- [Git](https://git-scm.com/downloads)
- [Docker](https://www.docker.com/products/docker-desktop). After installation, please create an account, open up the Docker application, and sign in.
- An [OpenAI API key](https://beta.openai.com/signup/)

## Getting Started :rocket:
1. **Open your editor**

2. **Open the Terminal** - Typically, you can do this from a 'Terminal' tab or by using a shortcut
(e.g., `Ctrl + ~` for Windows or `Control + ~` for Mac in VS Code).

4. **Clone the Repository and Navigate into the Directory** - Once your terminal is open, you can clone the repository and move into the directory by running the commands below.

**For Mac/Linux users** :apple: :penguin:
```bash
git clone https://github.com/reworkd/AgentGPT.git
cd AgentGPT
./setup.sh
```
**For Windows users** :windows:
```bash
git clone https://github.com/reworkd/AgentGPT.git
cd AgentGPT
./setup.bat
```
5. **Follow the setup instructions from the script** - add the appropriate API keys, and once all of the services are running, travel to [http://localhost:3000](http://localhost:3000) on your web-browser.

Happy hacking! :tada:

## 🎉 Roadmap

Expand Down

1 comment on commit 16657f4

@vercel
Copy link

@vercel vercel bot commented on 16657f4 Jun 27, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Successfully deployed to the following URLs:

docs – ./docs

docs-git-main-reworkd.vercel.app
docs-reworkd.vercel.app
docs.reworkd.ai

Please sign in to comment.