New PR from refs/heads/0522-23 on 2023-05-22T17:50:42-04:00

.env.example

@@ -1,18 +1,46 @@
 # Deployment Environment:
 NODE_ENV=development
 
+# NextJS
+NEXT_PUBLIC_BACKEND_URL=http://localhost:8000
+PLATFORM_URL=http://host.docker.internal:8000
+NEXT_PUBLIC_FORCE_AUTH=false
+
+# Websearch. Fill both of these values to enable it locally. https://serper.dev/ for an API key
+NEXT_PUBLIC_WEB_SEARCH_ENABLED=false
+SERP_API_KEY=***
+
 # Next Auth config:
 # Generate a secret with `openssl rand -base64 32`, or visit https://generate-secret.vercel.app/
 NEXTAUTH_SECRET=changeme
 NEXTAUTH_URL=http://localhost:3000
 
-# Prisma
+# Auth providers. Required to enable sign in, in production. Development mode uses local auth.
+GOOGLE_CLIENT_ID=***
+GOOGLE_CLIENT_SECRET=***
+GITHUB_CLIENT_ID=***
+GITHUB_CLIENT_SECRET=***
+DISCORD_CLIENT_SECRET=***
+DISCORD_CLIENT_ID=***
+
+# Database (Configured through docker-compose)
 DATABASE_USER=reworkd_platform
 DATABASE_PASSWORD=reworkd_platform
 DATABASE_HOST=db
 DATABASE_PORT=3306
 DATABASE_NAME=reworkd_platform
 DATABASE_URL="mysql://${DATABASE_USER}:${DATABASE_PASSWORD}@${DATABASE_HOST}:${DATABASE_PORT}/${DATABASE_NAME}"
 
+# Backend
+# Will mock calls to the OpenAI
+REWORKD_PLATFORM_FF_MOCK_MODE_ENABLED=false
+REWORKD_PLATFORM_OPENAI_API_KEY=changeme
+REWORKD_PLATFORM_FRONTEND_URL=http://localhost:3000
+REWORKD_PLATFORM_RELOAD=true
+REWORKD_PLATFORM_OPENAI_API_BASE="https://api.openai.com/v1"
+REWORKD_PLATFORM_SERP_API_KEY=***
+
 # External APIs:
+# Used while the backend is still in TypeScript
 OPENAI_API_KEY=changeme
+OPENAI_API_BASE="https://api.openai.com/v1"

.github/workflows/node.js.yml

@@ -3,8 +3,12 @@ name: Node.js CI
 on:
   push:
     branches: ["main"]
+    paths:
+      - 'next/**'
   pull_request:
     branches: ["main"]
+    paths:
+      - 'next/**'
 
 jobs:
   build:

.github/workflows/python.yml

@@ -1,9 +1,9 @@
 name: Testing Platform
 on:
-  push:
-    branches: [ "main" ]
-    paths:
-      - 'platform/**'
+#  push:
+#    branches: [ "main" ]
+#    paths:
+#      - 'platform/**'
   pull_request:
     branches: [ "main" ]
     paths:

.github/workflows/webhooks.yml

@@ -0,0 +1,22 @@
+name: Invoke Deployment Webhooks
+on:
+  workflow_dispatch:
+  push:
+    branches: [ "main" ]
+
+jobs:
+  invoke:
+    name: Invoke Webhooks
+    runs-on: ubuntu-latest
+    environment: production
+    if: github.repository == 'alexk1919/MackGPT'
+    steps:
+    - name: Trigger Webhooks
+      run: |
+        curl -L \
+          -X POST \
+          -H "Accept: application/vnd.github+json" \
+          -H ${{ secrets.WEBHOOK_AUTHORIZATION }} \
+          -H "X-GitHub-Api-Version: 2022-11-28" \
+          -d '{"ref":"main"}' \
+          ${{ secrets.DEPLOYMENT_WEBHOOK_URL }}

README.md

@@ -47,18 +47,7 @@ It will attempt to reach the goal by thinking of tasks to do, executing them, an
 
 
 ## 🎉 Roadmap
-
-This platform is currently in beta, we are currently working on:
-
-- Long term memory via a vector DB 🧠
-- Web browsing capabilities via LangChain 🌐
-- Interaction with websites and people 👨‍👩‍👦
-- Writing capabilities via a document API 📄
-- Saving agent runs 💾
-- Users and authentication 🔐
-- Stripe integration for a lower limit paid version (So we can stop worrying about infra costs) 💵
-
-More Coming soon...
+This platform is currently in beta, a full list of completed and planed features can be found on our [public roadmap](https://docs.reworkd.ai/roadmap).
 
 ## 🚀 Tech Stack
 
@@ -72,6 +61,7 @@ More Coming soon...
 - ✅ **End-to-end typesafe API**: [tRPC](https://trpc.io/).
 
 ## 👨‍🚀 Getting Started
+✨ For the latest guide, visit our [Setup documentation](https://docs.reworkd.ai/development/setup)
 
 ### 🐳 Docker Setup
 
@@ -102,7 +92,6 @@ use the provided setup script.
 ### 🛠️ Manual Setup
 
 > 🚧 You will need [Nodejs +18 (LTS recommended)](https://nodejs.org/en/) installed.
-
 1. Fork this project:
 
 - [Click here](https://github.com/alexk1919/MackGPT/fork).
@@ -116,7 +105,7 @@ git clone [email protected]:YOU_USER/MackGPT.git
 3. Install dependencies:
 
 ```bash
-cd MackGPT
+cd MackGPT/next
 npm install
 ```
 
@@ -127,11 +116,11 @@ npm install
 ```bash
 # Deployment Environment:
 NODE_ENV=development
-
 # Next Auth config:
 # Generate a secret with `openssl rand -base64 32`
 NEXTAUTH_SECRET=changeme
 NEXTAUTH_URL=http://localhost:3000
+NEXT_PUBLIC_BACKEND_URL=http://localhost:3000
 DATABASE_URL=file:./db.sqlite
 # Your open api key
 OPENAI_API_KEY=changeme

docker-compose.yml

@@ -9,8 +9,10 @@ services:
     ports:
       - "3000:3000"
     volumes:
-      - ./next/.env.docker:/app/.env
-      - ./db:/app/db
+      - ./next/.env:/next/.env
+      - ./next/:/next/
+      - /next/node_modules
+      - /next/.next
 
   platform:
     container_name: platform
@@ -27,7 +29,7 @@ services:
     environment:
       REWORKD_PLATFORM_HOST: 0.0.0.0
       REWORKD_PLATFORM_DB_HOST: db
-      REWORKD_PLATFORM_DB_PORT: "3306"
+      REWORKD_PLATFORM_DB_PORT: "3307"
       REWORKD_PLATFORM_DB_USER: "reworkd_platform"
       REWORKD_PLATFORM_DB_PASS: "reworkd_platform"
       REWORKD_PLATFORM_DB_BASE: "reworkd_platform"
@@ -40,11 +42,14 @@ services:
     restart: always
     build:
       context: ./db
+    ports:
+      - "3307:3307"
     environment:
       MYSQL_DATABASE: "reworkd_platform"
       MYSQL_USER: "reworkd_platform"
       MYSQL_PASSWORD: "reworkd_platform"
       MYSQL_ROOT_PASSWORD: "reworkd_platform"
+      MYSQL_TCP_PORT: 3307
     volumes:
       - db_data:/var/lib/mysql
     command: [ 'mysqld', '--character-set-server=utf8mb4', '--collation-server=utf8mb4_unicode_ci' ]

docs/docs/development/index.md

@@ -0,0 +1,10 @@
+---
+sidebar_position: 2
+hide_table_of_contents: true
+---
+
+import DocCardList from "@theme/DocCardList";
+
+# 🖥 Development
+
+<DocCardList />

docs/docs/development/prompts.md

@@ -0,0 +1,43 @@
+---
+sidebar_position: 3
+---
+
+# 💬 Prompts
+
+Prompts are what we use to dynamically align language model behaviour with the current agent goal / task. We primarily
+use `gpt-3.5-turbo` for our agents, and it has shown that its results are **heavily** influenced by the smallest details
+of its prompts.
+
+## Getting started with prompting
+
+- [Learn prompting docs](https://learnprompting.org/)
+- [Prompt engineering guide](https://www.promptingguide.ai/techniques/consistency)
+- [Prompt engineering for developers](https://www.deeplearning.ai/short-courses/chatgpt-prompt-engineering-for-developers/)
+
+## Key terms
+
+- **One shot / two shot / N shot:** You provide 1, 2, N examples alongside your prompt to further increase model
+  accuracy
+- **Zero shot:** You provide a prompt to a model directly (with no examples)
+
+## Techniques in AgentGPT
+
+### Plan and Solve
+
+[Plan and solve (PS)](https://arxiv.org/abs/2305.04091) builds upon chain of thought prompting, a prompting approach
+where simply asking a model for step-by-step instructions allows the model to more accurately reason about a problem. PS
+is a zero shot approach to increase accuracy in reasoning about abstract goals. In essence, it involves asking the model
+to:
+
+1. First understand the problem
+2. Extract relevant variables and corresponding values
+3. Devise a complete plan, **step by step**
+
+You can learn more through the paper's [GitHub repo](https://github.com/AGI-Edgerunners/Plan-and-Solve-Prompting). We
+leverage plan and solve prompting to generate our initial task list when the agent is first run. This technique is
+something similar to how BabyAGI operates.
+
+### ReAct
+
+ReAct stands for reasoning + action. It is a prompting technique that interleaves both reasoning and action generation
+into a single output, allowing the model to better synergize thoughts with actions.

docs/docs/development/setup.md

@@ -0,0 +1,64 @@
+---
+sidebar_position: 1
+---
+
+# 🛠️ Setup
+
+The following document will help you set up a local installation of AgentGPT.
+
+## Stack
+
+- 💅 Frontend: NextJS + Typescript
+- 🐍 Backend: FastAPI + Python
+- 📚 DB: MySQL through docker with the option of running SQLite locally
+
+## ENV
+
+Before you can get started, you need to ensure your ENV is correctly configured. To do this, copy over
+the [.env.example](https://github.com/reworkd/AgentGPT/blob/main/.env.example) file into the `./next/` directory, rename
+it to `.env` and update values as necessary. Some things to note:
+
+- You will need to update the `OPENAI_API_KEY` with your own value. See the [FAQ](/faq) for details
+- The DB ENV values are taken from definitions in `./docker-compose.yml`
+- To enable web search, set `NEXT_PUBLIC_WEB_SEARCH_ENABLED=true` and use [your own SERP api key](https://serper.dev/)
+  for `SERP_API_KEY`.
+
+## Using Docker
+
+The docker build is very straightforward and should work out of the box.
+Ensure you have docker installed by visiting [their website](https://www.docker.com/). After this, run the following
+command:
+
+```bash
+docker-compose up --build
+```
+
+This will spin up a container for the frontend, backend, and database.
+
+## Developing outside of docker
+
+Outside of docker, you'll need to just configure your ENV. Additionally, you can use `setup.sh` to walkthrough ENV
+configuration and also update your Prisma configuration to point to a local SQLite
+instance.
+
+After this, you can run the following to set up your Next.js project. We will add additional instructions for the Python
+backend when enabled.
+
+```bash
+// Frontend
+cd ./next
+npm install
+npm run dev
+```
+
+## Running the site
+
+After you have locally built AgentGPT, you can travel to http://localhost:3000/ in your web browser.
+
+## Issues / Additional help
+
+If you're still having trouble, you can follow a legacy guide from
+@CybrCo: [How to install AgentGPT locally](https://snapdragon-writer-867.notion.site/How-to-Install-AgentGPT-Locally-9b96b2314c9b491397976249fd121023)
+
+If you still face problems, please submit an [issue on GitHub](https://github.com/reworkd/AgentGPT/issues) or reach out
+to the team on [discord](https://discord.gg/jdSBAnmdnY).