Skip to content

Update PLUGIN_DEVELOPER_QUICKSTART.md #70

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 10, 2025
Merged

Update PLUGIN_DEVELOPER_QUICKSTART.md #70

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions PLUGIN_DEVELOPER_QUICKSTART.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,12 +16,12 @@ By the end of this guide you will be able to:

## Step 1: Install BrainDrive

Follow the [Installation Guide](https://github.com/BrainDriveAI/BrainDrive/blob/main/INSTALL.md)
Follow the [Installation Guide](https://github.com/BrainDriveAI/BrainDrive-Core/blob/main/INSTALL.md)

## Step 2: Install the Plugin Template

1. Go to BrainDrive Plugin Manager → Install Plugins
2. Enter URL: `https://github.com/BrainDriveAI/PluginTemplate`
2. Enter URL: `https://github.com/BrainDriveAI/BrainDrive-PluginTemplate
3. Click Install
4. Wait for green success message

Expand All @@ -42,7 +42,7 @@ Follow the [Installation Guide](https://github.com/BrainDriveAI/BrainDrive/blob/
**Clone the template:**
```bash
# In your preferred development folder
git clone https://github.com/BrainDriveAI/PluginTemplate.git MyPlugin
git clone https://github.com/BrainDriveAI/BrainDrive-PluginTemplate.git MyPlugin
cd MyPlugin
npm install
```
Expand All @@ -58,7 +58,7 @@ npm install
- Uncomment and update with your backend path:
```javascript
output: {
path: path.resolve(__dirname, '/path/to/your/BrainDrive/backend/plugins/shared/PluginTemplate/v1.0.0/dist'),
path: path.resolve(__dirname, '/path/to/your/BrainDrive-Core/backend/plugins/shared/PluginTemplate/v1.0.0/dist'),
// ... rest of config
}
```
Expand All @@ -74,7 +74,7 @@ npm install

1. **Edit the plugin:**
```bash
# Open src/PluginTemplate.tsx
# Open src/BrainDrive-PluginTemplate.tsx
# Change the title to "My Awesome Plugin!!"
```

Expand Down Expand Up @@ -158,4 +158,4 @@ The only limit is your imagination. Your AI. Your Rules.

- 💬 [Developer Forum](https://community.braindrive.ai) - Get help and share plugins
- 📖 [API Documentation](http://localhost:8005/api/v1/docs) - Backend endpoints (when running locally)
- 🐛 [Report Issues](https://github.com/BrainDriveAI/BrainDrive/issues) - Use `[plugin]` tag
- 🐛 [Report Issues](https://github.com/BrainDriveAI/BrainDrive-Core/issues) - Use `[plugin]` tag