Development

Developer Resources

Everything you need to build with AIPex or contribute to the project.

Contributing Guide

Learn how to contribute to AIPex. We welcome bug reports, feature requests, and pull requests.

API Reference

Complete API documentation for developers building custom automation with AIPex.

Architecture

Understand AIPex's architecture, design decisions, and technical implementation.

MCP Protocol

Learn about the Model Context Protocol (MCP) that powers AIPex's tools.

Quick Links

GitHub Repository

View source code, report issues, and contribute

Discussions

Join the community and ask questions

Issue Tracker

Report bugs and request features

Getting Started with Development

Prerequisites

Node.js 18+ and pnpm
Chrome/Chromium browser
Basic knowledge of TypeScript and React
Familiarity with Chrome Extension APIs

Setup Development Environment

Clone the Repository

git clone https://github.com/AIPexStudio/AIPex.git
cd AIPex

Install Dependencies

pnpm install

Start Development Server

pnpm dev

Load Extension in Chrome

Open chrome://extensions/
Enable "Developer mode"
Click "Load unpacked"
Select the build/chrome-mv3-dev directory

Project Structure

AIPex/
├── src/
│   ├── background/     # Background service worker
│   ├── content/        # Content scripts
│   ├── popup/          # Extension popup UI
│   ├── sidepanel/      # Side panel UI
│   ├── tools/          # MCP tools implementation
│   └── utils/          # Shared utilities
├── assets/             # Static assets
├── .cursor/            # Cursor rules for AI development
└── package.json

Contributing

We welcome contributions of all kinds! Here's how you can help:

Ways to Contribute

Report Bugs

Found a bug? Open an issue with detailed reproduction steps

Suggest Features

Have an idea? Start a discussion to gather feedback

Submit Code

Fix bugs or implement features with pull requests

Improve Docs

Help make our documentation better and more comprehensive

Contribution Process

Fork the repository
Create a feature branch (git checkout -b feature/amazing-feature)
Commit your changes (git commit -m 'Add amazing feature')
Push to the branch (git push origin feature/amazing-feature)
Open a Pull Request

Code Guidelines

Follow TypeScript best practices
Write clear, descriptive commit messages
Add tests for new features
Update documentation as needed
Follow the existing code style

Community

Join our growing community of 10K+ users and 573 GitHub stars!

Get Involved

⭐ Star us on GitHub: Show your support
🍴 Fork the project: Build your own version
💬 Join discussions: Share ideas and get help
🐛 Report issues: Help us improve
📝 Write tutorials: Share your knowledge

License

AIPex is MIT licensed and completely free to use, modify, and distribute.

MIT License

Copyright (c) 2025 AIPex Studio

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files...