🚀 Get Started Fast

🚀 Quick Start Guide

Ready to dive into BigBull.AI? Awesome! Whether you're here to explore the code, build new strategies, or just see what our AI-powered DeFi trading platform can do, we'll get you set up in no time.

---

Before You Start

You'll need a few things installed:

🔹 Node.js (version 23 or newer) 🔹 pnpm (our package manager of choice)

npm install -g pnpm

🔹 Git (for cloning the code) 🔹 Basic coding knowledge (TypeScript/Node.js)

---

Let's Get Started!

1. Grab the Code

First, clone the repository and switch to the project directory:

git clone https://github.com/PLACEHOLDER/bigbullai.git  
cd bigbullai  

2. Set Up Your Environment

Create a .env file in the root directory with your API keys and configuration:

cp .env.example .env

Open .env in your favorite editor and add your details:

OPENAI_API_KEY=your_openai_key_here  
BINANCE_API_KEY=your_binance_api_key_here  
BINANCE_API_SECRET=your_binance_api_secret_here  
PRIVATE_KEY=your_private_key_here  

3. Install Dependencies

Install all required packages:

pnpm install  

4. Build the Project

Compile the project code:

cd core  
pnpm build  

5. Start the Server

Launch the server:

pnpm start  

6. Launch the Web Interface

Open a new terminal window and run:

cd client  
pnpm run dev  

Access the web interface at http://localhost:3000 (unless it's mapped to a different port).

---

What's Next?

🔎 Explore the Code

Check out the core directory – that’s where the multi-agent magic happens. Take a look at our System Overview to understand the architecture, or dive into the Multi-Agent System to see how the agents work together.

📚 Check Out the Docs

Our docs folder is packed with helpful tips and insights to get you started.

🌐 Join the Community

Need help or want to brainstorm strategies? Jump into our Discord – the BigBull.AI community is ready to collaborate!

---

✨ That’s it! You’re all set to begin your BigBull.AI journey. Happy trading! 🚀