Skip to content

Commit 12a8228

Browse files
krushit-redsoftkrushit-redsoft
committed
add: onelead intro and installation
1 parent 22f21a5 commit 12a8228

File tree

4 files changed

+161
-26
lines changed

4 files changed

+161
-26
lines changed

‎docs/index.md

Lines changed: 93 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,99 @@
1-
# OneLead - Lead Management Solution
1+
# One Suite Documentation
22

3-
OneLead is a **Frappe-based lead management system** designed to seamlessly integrate with multiple lead sources, including **Meta (Facebook) Leads** and **Google Leads**. It automates lead collection, processing, and assignment within your business workflow.
3+
Welcome to the One Suite Documentation, your go-to resource for understanding and using **OneLead** and **OneInbox**—two open-source applications built on the **Frappe framework**.
44

5-
## Lead Sources
5+
One Suite is an extendable solution designed to integrate lead management and customer communication workflows. It enables businesses to **automate lead collection, streamline messaging, and centralize customer interactions**.
66

7-
### 🔹 Meta Leads
8-
OneLead integrates with **Meta (Facebook) Lead Ads**, allowing businesses to **automatically capture** leads from Facebook and Instagram ad campaigns, map them to internal CRM systems, and assign them to sales teams.
7+
## Overview of One Suite
98

10-
### 🔹 Google Leads
11-
With OneLead's **Google Lead Integration**, you can fetch leads directly from **Google Ads Lead Form Extensions**, ensuring that every inquiry is instantly available in your CRM for follow-up.
9+
One Suite provides a **Frappe-based** centralized system for managing leads and communications. It integrates with **Meta (Facebook), Google, Instagram, WhatsApp, and Messenger** to ensure seamless data flow and automation.
1210

13-
## Features
14-
- 🔄 **Automated lead fetching** from Meta & Google.
15-
- 📌 **Custom mapping** to internal lead structures.
16-
- 📊 **Lead tracking & assignment** based on business rules.
17-
- 🔗 **Webhook-based integration** for real-time updates.
11+
**GitHub Repository:** [One Suite on GitHub](https://github.com/redsoftware-hq/one-docs)
1812

19-
Proceed to **Meta Integration** for detailed setup instructions.
13+
---
14+
15+
## Products in One Suite
16+
17+
### **OneLead – Open-Source Lead Capture & Integration**
18+
19+
OneLead is a Frappe-based lead automation application that integrates with:
20+
21+
- **Meta (Facebook) Ads** – Captures leads from Facebook and Instagram lead forms.
22+
- **Google Leads** – Fetches leads from Google Ads Lead Form Extensions.
23+
24+
**Key Features:**
25+
26+
- Open-source and customizable lead management system.
27+
- Automated lead fetching from Meta and Google.
28+
- Webhook-based integration for real-time updates.
29+
- Lead assignment and tracking within the Frappe framework.
30+
31+
**Documentation:** [OneLead Documentation](onelead/index.md)
32+
**GitHub Repository:** [OneLead on GitHub](https://github.com/redsoftware-hq/onelead)
33+
34+
---
35+
36+
### **OneInbox – Open-Source Multi-Channel Messaging Integration**
37+
38+
OneInbox is a **Frappe-based communication management application** that integrates with multiple messaging platforms:
39+
40+
- **Messenger** – Manage Facebook Messenger conversations within your system.
41+
- **Instagram** – Receive and reply to Instagram direct messages.
42+
- **WhatsApp** – Handle customer interactions via the WhatsApp Cloud API.
43+
44+
**Key Features:**
45+
46+
- open-source Application built on Frappe.
47+
- Centralized messaging inbox for handling multiple platforms.
48+
- Integration with existing CRM workflows within Frappe.
49+
50+
**Documentation:** [OneInbox Documentation](oneinbox/index.md)
51+
**GitHub Repository:** [OneInbox on GitHub](https://github.com/redsoftware-hq/oneinbox)
52+
53+
---
54+
55+
## Why Use One Suite?
56+
57+
- **Built on Frappe** – Leverages a robust framework for extensibility and customization.
58+
- **Self-Hosted & Open-Source** – Deploy and modify it according to business needs.
59+
- **Seamless Integrations** – Works with Meta Ads, Google Leads, WhatsApp, and more.
60+
- **Automated Workflows** – Reduce manual effort with webhook-based processing.
61+
- **CRM-Friendly** – Designed to work with Frappe-based CRM systems.
62+
63+
For troubleshooting and setup assistance, visit the [Troubleshooting Guide](troubleshooting/index.md).
64+
65+
---
66+
67+
## Getting Started
68+
69+
If you're new to One Suite, follow the setup guides:
70+
[OneLead Setup Guide](onelead/installation.md)
71+
[OneInbox Setup Guide](oneinbox/installation.md)
72+
73+
---
74+
75+
## Future Enhancements
76+
77+
Upcoming improvements include:
78+
79+
- Lead scoring and enrichment features in OneLead.
80+
- AI-driven chat automation for OneInbox.
81+
- Advanced analytics and reporting capabilities.
82+
83+
Stay updated in the [Upcoming Features](future/upcoming_features.md) section.
84+
85+
---
86+
87+
## Contribute to One Suite
88+
89+
One Suite is an **open-source project**, and community contributions are encouraged.
90+
91+
- Report issues or suggest features on GitHub.
92+
- Submit pull requests to enhance functionality.
93+
- Participate in discussions and help improve documentation.
94+
95+
[Contribution Guide](contributing.md)
96+
97+
---
98+
99+
Explore the documentation for [OneLead](onelead/index.md) and [OneInbox](oneinbox/index.md) to get started.

‎docs/onelead/index.md

Lines changed: 15 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,19 @@
1-
# Meta Integration for OneLead
1+
# OneLead - Lead Management Solution
22

3-
OneLead provides **seamless integration with Meta (Facebook) Lead Ads**, ensuring that leads from your Facebook and Instagram campaigns are instantly available in your CRM.
3+
OneLead is a **Frappe-based lead management system** designed to seamlessly integrate with multiple lead sources, including **Meta (Facebook) Leads** and **Google Leads**. It automates lead collection, processing, and assignment within your business workflow.
44

5-
## How It Works
6-
- **Captures leads** from Facebook Lead Forms via webhooks.
7-
- **Maps leads** to internal CRM structures based on configurations.
8-
- **Assigns leads** to users or teams automatically.
9-
- **Tracks lead performance** through analytics.
5+
## Lead Sources
106

11-
## Key Setup Steps
12-
1. **Register a Meta App** on the [Facebook Developer Portal](https://developers.facebook.com/).
13-
2. **Configure Webhooks** to receive real-time lead data.
14-
3. **Generate and validate User Access Tokens**.
15-
4. **Map Meta Ad Pages and Forms** inside OneLead.
7+
### 🔹 Meta Leads
8+
OneLead integrates with **Meta (Facebook) Lead Ads**, allowing businesses to **automatically capture** leads from Facebook and Instagram ad campaigns, map them to internal CRM systems, and assign them to sales teams.
169

17-
For a complete guide on **Meta Webhook Configuration**, go to [Meta Webhook Config](meta_webhook_config.md).
10+
### 🔹 Google Leads
11+
With OneLead's **Google Lead Integration**, you can fetch leads directly from **Google Ads Lead Form Extensions**, ensuring that every inquiry is instantly available in your CRM for follow-up.
12+
13+
## Features
14+
- 🔄 **Automated lead fetching** from Meta & Google.
15+
- 📌 **Custom mapping** to internal lead structures.
16+
- 📊 **Lead tracking & assignment** based on business rules.
17+
- 🔗 **Webhook-based integration** for real-time updates.
18+
19+
Proceed to **Meta Integration** for detailed setup instructions.

‎docs/onelead/installation.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# Installing OneLead
2+
3+
OneLead is an **open-source Frappe application** designed for lead management, integrating with **Meta (Facebook) Ads** and **Google Leads**. This guide provides step-by-step instructions for installing and setting up OneLead on a Frappe-based system.
4+
5+
---
6+
7+
## **1. Prerequisites**
8+
Before installing OneLead, ensure the following requirements are met:
9+
10+
### **System Requirements**
11+
- **Frappe Framework** (v15)
12+
- **Bench CLI** installed
13+
14+
### **Meta Accounts**
15+
- **Facebook Developer Account** ([Sign Up](https://developers.facebook.com/))
16+
17+
---
18+
19+
## **2. Installation Steps**
20+
21+
### **Step 1: Set Up a Frappe Site**
22+
If you do not already have a running Frappe instance, install Frappe and create a new site:
23+
24+
```bash
25+
26+
# Create a new Bench directory
27+
bench init --frappe-branch version-15 one-bench
28+
cd one-bench
29+
30+
# Create a new Frappe site
31+
bench get-app https://github.com/redsoftware-hq/onelead
32+
33+
bench --site mysite.local install-app onelead
34+
```
35+
36+

‎docs/onelead/meta/index.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# Meta Integration for OneLead
2+
3+
OneLead provides **seamless integration with Meta (Facebook) Lead Ads**, ensuring that leads from your Facebook and Instagram campaigns are instantly available in your CRM.
4+
5+
## How It Works
6+
- **Captures leads** from Facebook Lead Forms via webhooks.
7+
- **Maps leads** to internal CRM structures based on configurations.
8+
- **Assigns leads** to users or teams automatically.
9+
- **Tracks lead performance** through analytics.
10+
11+
## Key Setup Steps
12+
1. **Register a Meta App** on the [Facebook Developer Portal](https://developers.facebook.com/).
13+
2. **Configure Webhooks** to receive real-time lead data.
14+
3. **Generate and validate User Access Tokens**.
15+
4. **Map Meta Ad Pages and Forms** inside OneLead.
16+
17+
For a complete guide on **Meta Webhook Configuration**, go to [Meta Webhook Config](meta_webhook_config.md).

0 commit comments

Comments
 (0)