-
-
Notifications
You must be signed in to change notification settings - Fork 9.2k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
☝️ Update README.md #865
☝️ Update README.md #865
Changes from 1 commit
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -44,18 +44,60 @@ 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) | ||
## Prerequisites :point_up: | ||
|
||
Before you get started, please make sure you have the following installed: | ||
|
||
- [Visual Studio Code (VS Code)](https://code.visualstudio.com/download) | ||
- [Node.js](https://nodejs.org/en/download) | ||
asim-shrestha marked this conversation as resolved.
Show resolved
Hide resolved
|
||
- [Docker](https://www.docker.com/products/docker-desktop) | ||
- An [OpenAI API key](https://beta.openai.com/signup/) | ||
|
||
For Docker, after installation, please create an account, download Docker, and sign in to your account. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Lets put this alongside the docker bullet point above
|
||
|
||
|
||
## Getting Started :rocket: | ||
|
||
1. **Open VS Code** | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Open your editor* |
||
- You can do this by searching for it in your applications or clicking on the shortcut if you have one. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I think this is too much info, can be explained in a video if anything |
||
|
||
2. **Open the Terminal in VS Code** | ||
- You can do this by clicking on the 'Terminal' tab at the top or by using the shortcut `Ctrl + ~` for Windows or `Control + ~` for Mac. | ||
|
||
3. **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 following commands: | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Need clone instructions, should probably inline the Max / windows stuff |
||
|
||
For Mac/Linux users :apple: :penguin: | ||
|
||
To get started on Mac/Linux, run the commands below. | ||
```bash | ||
git clone https://github.com/reworkd/AgentGPT.git && cd AgentGPT | ||
``` | ||
For Windows users :windows: | ||
|
||
```bash | ||
git clone https://github.com/reworkd/AgentGPT.git | ||
cd AgentGPT | ||
``` | ||
|
||
**Run the Setup File** | ||
- This will set up everything you need for the project. | ||
|
||
For Mac/Linux users :apple: :penguin: | ||
```bash | ||
./setup.sh | ||
``` | ||
If you are on windows, you can do the following after downloading the repo. | ||
For Windows users :windows: | ||
|
||
```bash | ||
./setup.bat | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Lets not have a separate thing for Mac/Linux and Windows for every step. We should have one mac section and one windows section |
||
``` | ||
setup.bat | ||
## Build and Run the Docker Container | ||
|
||
Finally, you can build and run the Docker container with the following command: | ||
```bash | ||
docker-compose up --build | ||
``` | ||
> 🐳 The recommend way to set up AgentGPT locally is to [docker-compose](https://www.docker.com/), please make sure you have docker installed. | ||
Happy hacking! :tada: | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Lets also add. 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 on your web-browser |
||
|
||
## 🎉 Roadmap | ||
|
||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Lets not propose any specific editor. Maybe say download the editor of your choice, for example, VSCode