Skip to content

Latest commit

 

History

History
182 lines (129 loc) · 5.33 KB

README.md

File metadata and controls

182 lines (129 loc) · 5.33 KB
Raw

🤖 Create, customize, and launch autonomous AI Agents in your browser. 🤖

Node version English

🔗 Short link   •   🐦 Twitter

💝 Support the Advancement of MackGPT!! 💝

Boost the development of MackGPT, an open-source project pushing AI autonomy forward! Your support helps cover operational costs, such as in-house API and infrastructure expenses, which are growing daily. Your sponsorship drives progress by facilitating resource scaling, feature improvement, and continuous innovation in this groundbreaking project! 🚀

By sponsoring this open-source project, you can showcase your avatar/logo below while contributing to the progress of autonomous AI!🗣️

👉 Click here to support the project

MackGPT allows you to create, customize, and deploy Autonomous AI agents in your browser. Name your own custom AI and have it embark on any goal imaginable. It will attempt to reach the goal by thinking of tasks to do, executing them, and learning from the results 🚀.

🎉 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...

🚀 Tech Stack

👨‍🚀 Getting Started

🐳 Docker Setup

The easiest way to run MackGPT locally is by using docker. A convenient setup script is provided to help you get started.

./setup.sh --docker

Docker-compose

Using docker-compose deploy

./setup.sh --docker-compose

👷 Local Development Setup

If you wish to develop MackGPT locally, the easiest way is to use the provided setup script.

./setup.sh --local

🛠️ Manual Setup

🚧 You will need Nodejs +18 (LTS recommended) installed.

  1. Fork this project:
  1. Clone the repository:
git clone [email protected]:YOU_USER/MackGPT.git
  1. Install dependencies:
cd MackGPT
npm install
  1. Create a .env file with the following content:

🚧 The environment variables must match the following schema.

# Deployment Environment:
NODE_ENV=development

# Next Auth config:
# Generate a secret with `openssl rand -base64 32`
NEXTAUTH_SECRET=changeme
NEXTAUTH_URL=http://localhost:3000
DATABASE_URL=file:./db.sqlite
# Your open api key
OPENAI_API_KEY=changeme
  1. Modify prisma schema to use sqlite:
./prisma/useSqlite.sh

Note: This only needs to be done if you wish to use sqlite.

  1. Ready 🥳, now run:
# Create database migrations
npx prisma db push
npm run dev

🚀 GitHub Codespaces

Set up MackGPT in the cloud immediately by using GitHub Codespaces.

  1. From the GitHub repo, click the green "Code" button and select "Codespaces".
  2. Create a new Codespace or select a previous one you've already created.
  3. Codespaces opens in a separate tab in your browser.
  4. In terminal, run bash ./setup.sh --local
  5. When prompted in terminal, add your OpenAI API key.
  6. Click "Open in browser" when the build process completes.
  • To shut MackGPT down, enter Ctrl+C in Terminal.
  • To restart MackGPT, run npm run dev in Terminal.

Run the project 🥳

npm run dev

❤️ Credits

This project is based on AgentGPT GitHub Repo. Our work is derived from or inspired by their efforts under the GPL 3.0 license. We greatly appreciate their efforts and the valuable work they have shared with the community. Thank you to everyone involved in creating, maintaining, and contributing to this open-source project.