Skip to content

Sonic Academy redefines blockchain education and AI agent creation by combining personalized learning with a user-friendly AI Builder.

Notifications You must be signed in to change notification settings

thopatevijay/SonicAcademy

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

84 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Sonic Academy

Sonic Academy is an innovative platform designed to make learning about the Sonic blockchain accessible, engaging, and personalized for everyone. Whether you're a beginner eager to explore blockchain or a developer aiming to build AI agents on Sonic, Sonic Academy provides an intuitive, gamified experience to guide you every step of the way. Built on the ElizaOS framework, it opens the door to blockchain education and agent creation for all.

Table of Contents

Project Overview

Sonic Academy redefines blockchain education and AI agent creation by combining personalized learning with a user-friendly AI Builder. Powered by the ElizaOS framework and custom plugins like sonic-plugin and sonic-agent-academy-plugin, it offers:

  • Interactive Lessons: Tailored to your age, learning style, and experience level.
  • AI Agent Creation: Build your own AI agents on the Sonic blockchain in just 1-2 steps, no coding required.
  • Developer Tools: Plugins to extend Sonic blockchain functionality for technical users.

Use Cases

Traditional blockchain resources, like documentation, are often static, technical, and geared toward developers. Sonic Academy changes that by addressing these key challenges:

  • Dynamic Learning: Unlike static docs, Sonic Academy adapts lessons to your unique learning style (e.g., visual, auditory) and experience level, making blockchain approachable for everyone.
  • Inclusive Education: Non-technical users can learn about the Sonic blockchain without being overwhelmed by jargon-heavy docs, opening the door to a broader audience.
  • Simplified AI Agents: The concept of AI agents is exciting but often feels exclusive to tech users. Sonic Academy’s AI Builder lets anyone create their own agents on the Sonic blockchain in 1-2 easy steps.
  • Trust and Ownership: Users don’t have to rely on pre-built AI agents created by others. With Sonic Academy, you build your own, fostering trust and personal connection.
  • Developer Support: Developers can learn Sonic and integrate the sonic-plugin to create advanced agents or blockchain features in their projects.
  • Community Engagement: Our Twitter AI agent, Prof.SonicAcademy, educates, engages, and grows the Sonic community—an example of what users can create.

Features

  • User Interface: A sleek, gamified UI where users can learn about Sonic and build their own on-chain AI agents.
  • sonic-plugin: A custom ElizaOS plugin powering Sonic blockchain actions:
    • Actions: TRANSFER_TOKEN and GET_BALANCE.
    • Secure Wallet: Includes SonicWalletProvider for safe transactions.
    • Integration: Embedded in the AI Builder for seamless agent creation. Developers can also use it standalone to build Sonic-based agents. GitHub Link
  • sonic-agent-academy-plugin: A plugin generating personalized Sonic blockchain lessons: GitHub Link
    • Personalization: Lessons adapt to user inputs (age, style, experience).
    • Extensibility: Developers can integrate it into their ElizaOS projects to create custom lessons.
    • Upcoming: Visual and video lessons in development.
  • AI Builder: A beginner-friendly tool to create AI agents in easy steps, leveraging sonic-plugin for on-chain deployment.
  • Live Twitter AI Agent: Prof.SonicAcademy is a real-world example of an AI agent built with Sonic Academy, guiding the community on Twitter. GitHub Link

Tech Stack

Installation & Setup

To run Sonic Academy locally:

Clone the repository:

git clone https://github.com/thopatevijay/SonicAcademy.git
cd SonicAcademy

This is the main repository for SonicAcademy, containing the following directory structure:

SonicAcademy/
├── agent/
└── client/
  • agent/: Serves as the backend.

  • client/: Serves as the frontend.

Frontend (Client)

The client directory is deployed on Vercel at link. To run the frontend locally, follow these steps:

  1. Navigate to the client directory:

    cd client
  2. Install dependencies:

    npm install
  3. Start the development server:

    npm run dev

This will launch the client application locally.

Backend (Agent)

The agent directory was originally forked from the "eliza-starter" kit provided by elizaOS. However, due to frequent changes in the elizaOS core repository, it faced dependency issues, making it difficult to deploy on a server or create new agents.

These issues have been resolved in the elizaOS core repository. As a result, I forked it to create a more stable backend called "SONIC-ACADEMY" (repository link). This repository is deployed on the Railway platform and now serves as the backend for the SonicAcademy project, replacing the original agent directory's functionality.

I recommend using the "SONIC-ACADEMY" repository for the backend to ensure better stability and sustainable performance.

Setting Up the Backend Locally

To set up the "SONIC-ACADEMY" backend on your local machine, please follow the instructions provided in its repository: SONIC-ACADEMY README.

Testing the Project

To test the SonicAcademy project locally, follow these steps:

  1. Start the Frontend: Launch the client as described in the "Frontend (Client)" section above.

  2. Start the Backend: Run the "SONIC-ACADEMY" backend locally. Update the server port in its environment variables (e.g., set it to 7171).

  3. Configure Client Environment Variables: In the client directory, set the following environment variables to point to your local backend, ensuring the port matches the one used by "SONIC-ACADEMY" (e.g., 7171):

    env

    NEXT_PUBLIC_CREATE_AGENT_URL=http://localhost:7171
    NEXT_PUBLIC_CREATE_LESSON_URL=http://localhost:7171
    
  4. With both the frontend and backend running, you should be able to test the SonicAcademy project locally.

Alternatively, the "SONIC-ACADEMY" backend is deployed live on the Railway platform. If you need the live URL for testing, please send me a direct message on Telegram at @thopate_vijay .

Available Agents

SonicAcademy currently features three specialized agents, each designed to assist with different aspects of the Sonic blockchain ecosystem. Below is a list of the agents along with a concise description of their capabilities:

  1. SonicAgent See Character file here

    • A blockchain assistant that helps users execute token transfers and check wallet balances on the Sonic network.
  2. SonicTutor See Character file here

    • An AI educator that simplifies complex blockchain concepts and creates lessons using the provided knowledge base.
  3. Prof.SonicAcademy See charcater file here

    • An AI-driven Twitter agent that educates and engages the Sonic blockchain community, simplifying concepts and encouraging interaction.

Usage

  1. Landing Page: Enter your age group, learning style, and experience level to get started.

  2. Lessons: Receive personalized text-based lessons about the Sonic blockchain, powered by sonic-agent-academy-plugin.

  3. AI Builder: Create your own AI agent in 1-2 steps, deployed on-chain via sonic-plugin.

  4. Developer Use: Integrate sonic-plugin and sonic-agent-academy-plugin into your ElizaOS projects for custom agents or lessons.

Future Enhancements

The proof-of-concept is just the beginning! Here’s what’s on the horizon:

  • More Lessons: Expand to advanced topics like DeFi strategies and Sonic governance.

  • Agent Marketplace: Share or sell your agents with the community.

  • Gamified Rewards: Introduce leaderboards, badges, or staking incentives.

  • Multi-Language Support: Translate lessons for global users.

  • Advanced Agent Customization: Enable complex behaviors and additional on-chain actions.

  • Multimedia Lessons: Add visual and video content to sonic-agent-academy-plugin for diverse learners.

  • Pro Version: Launch a subscription-based Pro tier with extra features, including priority support, early access to new lessons, and advanced agent-building tools.

Contributing

We’d love your help! To contribute:

  1. Fork the repository.

  2. Create a branch for your feature or fix.

  3. Submit a pull request with a clear description.

License

This project is licensed under the MIT License.

Built with ❤️ for the Sonic DeFAI Hackathon, March 2025.

About

Sonic Academy redefines blockchain education and AI agent creation by combining personalized learning with a user-friendly AI Builder.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages