An open API service indexing awesome lists of open source software.

https://github.com/barkprotocol/ai-agent-app


https://github.com/barkprotocol/ai-agent-app

Last synced: over 1 year ago
JSON representation

Awesome Lists containing this project

README

          

# Bark AI Agent Platform
v1.0-Beta

![Bark AI Agent WebUI](/github/assets/ai-agent-webui.png)

---

![Bark AI Chatbot UI](/github/assets/dashboard.png)

## Overview

The **Bark AI Agent WebApp** is a cutting-edge platform that merges **artificial intelligence** and **blockchain technology** to provide users with intelligent, automated trading strategies and real-time market insights on the **Solana blockchain**.

## ✨ Features

- **AI-powered chatbot**: User friedly dashboard and AI chatbot.
- **AI-powered trading assistant**: Make smarter, automated trading decisions with advanced AI models.
- **Real-time market analysis**: Stay updated with live market trends and data for the Solana blockchain.
- **Secure wallet integration**: Seamlessly connect your wallet to manage assets with security and ease.
- **DeFi yield optimization**: Optimize yield farming strategies for the highest returns across decentralized finance protocols.
- **Cross-chain compatibility**: Leverage multiple blockchain ecosystems for maximum flexibility.
- **Community governance**: Participate in decision-making processes via decentralized governance mechanisms.
- **Early Access Program (EAP)**: Access exclusive features and tools before they are available to the public.

## πŸ›  Technologies Used

- **Next.js 15** (App Router) for optimized routing and server-side rendering.
- **React** for building dynamic user interfaces.
- **TypeScript** for type safety and improved developer experience.
- **Tailwind CSS** for highly customizable and responsive design.
- **Prisma** for database interactions with easy-to-use ORM.
- **Solana Web3.js** for connecting with the Solana blockchain and interacting with smart contracts.
- **Helius SDK** for robust and scalable API interactions with the Solana network.
- **Framer Motion** for smooth animations and transitions.
- **ShadCN UI Components** for a set of highly customizable UI elements.

## πŸ“¦ Installation

To get started with the **Bark AI Agent Dashboard**, follow the steps below:

### 1. Clone the Repository

First, clone the repository to your local machine:

```bash
git clone https://github.com/your-username/bark-ai-agent.git
cd bark-ai-agent
```

### 2. Install Dependencies

Install the necessary dependencies using **npm**, **yarn**, or **pnpm**:

```bash
# Using npm
npm install

# Or using yarn
yarn install

# Or using pnpm
pnpm install
```

### 3. Set Up Environment Variables

Create a `.env.local` file at the root of the project and add the necessary environment variables. Here’s an example configuration:

```dotenv
# Solana Configuration
SOLANA_RPC_URL=https://api.mainnet-beta.solana.com
HELIUS_API_KEY=your-helius-api-key

# Database Configuration
DATABASE_URL=your-database-connection-string

# AI Configuration (if applicable)
OPEN_AI_API_KEY=your-ai-api-key

# Other required environment variables
NEXT_PUBLIC_PRIVY_APP_ID=your-privy-app-id
```

### 4. Run the Development Server

Once the environment variables are set up, run the development server:

```bash
# Using npm
npm run dev

# Or using yarn
yarn dev

# Or using pnpm
pnpm dev
```

Visit `http://localhost:3000` to view the dashboard in your browser.

## πŸ—Ό Project Structure

The project is organized into the following directories:

- **`/app`**: Contains the App Router and components for the dashboard.
- **`/components`**: Reusable UI components like buttons, cards, and modals.
- **`/lib`**: Utility functions and helpers.
- **`/styles`**: Tailwind CSS configuration and custom styles.
- **`/prisma`**: Database schema and Prisma client setup.

## βš™οΈ How to Contribute

We welcome contributions to the Bark AI Agent Dashboard project! To get started:

1. Fork the repository.
2. Create a new branch for your feature or fix.
3. Make your changes and test them.
4. Submit a pull request (PR) with a detailed explanation of your changes.

Please make sure to follow the code style and run tests before submitting a PR.

## πŸ“„ License

This project is licensed under the **MIT License**.

---

### Key Updates:

1. **Features**: Updated the language slightly to make it sound more engaging and professional.
2. **Technologies Used**: Listed out all technologies, tools, and libraries that power the dashboard.
3. **Installation Instructions**: More detailed steps on how to get started with the project, including setting up the environment variables.
4. **Project Structure**: Helps new developers understand how the project is organized.
5. **How to Contribute**: Encourages community contributions and provides guidelines for new contributors.
6. **License**: Added a placeholder for licensing.

### Next Steps:

1. **Provide Real API Keys**: Make sure to update the environment variables section with actual keys and setup instructions.
2. **Improve Documentation**: Add more details on specific features, such as how to connect a wallet or use AI-powered features.
3. **Deploy the Application**: Once the app is ready, deploy it to a platform like Vercel or Netlify to showcase it live.