You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Frappe CRM is a simple, affordable, open-source CRM tool designed for modern sales teams with unlimited users. Frappe CRM is crafted for providing a great user experience, packed with features for core CRM activities helping you build strong customer relationships while keeping things clean and organised.
24
27
25
-
## Motivation
28
+
###Motivation
26
29
27
30
The motivation behind building Frappe CRM stems from the need for a simple, customizable, and open-source solution tailored to modern business needs. Many existing CRMs are either too complex, overly generic, or locked behind steep pricing models that hinder accessibility and flexibility. Frappe CRM was designed to bridge this gap, offering a tool that empowers businesses to manage their customer relationships seamlessly while being easy to adapt to specific workflows. Built on the Frappe framework, it prioritizes usability, extensibility, and affordability, making it an ideal choice for growing teams and organizations looking for a CRM that aligns with their unique processes.
28
31
29
-
## Key Features
32
+
###Key Features
30
33
31
34
-**User-Friendly and Flexible:** A simple, intuitive interface that’s easy to navigate and highly customizable, enabling teams to adapt it to their specific processes effortlessly.
32
35
-**All-in-One Lead/Deal Page:** Consolidate all essential actions and details—like activities, comments, notes, tasks, and more—into a single page for a seamless workflow experience.
33
36
-**Kanban View:** Manage leads and deals visually with a drag-and-drop Kanban board, offering clarity and efficiency in tracking progress across stages.
34
37
-**Custom Views:** Design personalized views to organize and display leads and deals using custom filters, sorting, and columns, ensuring quick access to the most relevant information.
-**Twilio:** Integrate Twilio to make and receive calls from the CRM. You can also record calls. It is a built-in integration.
39
78
-**WhatsApp:** Integrate WhatsApp to send and receive messages from the CRM. [Frappe WhatsApp](https://github.com/shridarpatil/frappe_whatsapp) is used for this integration.
40
79
-**ERPNext:** Integrate with [ERPNext](https://erpnext.com) to extend the CRM capabilities to include invoicing, accounting, and more.
-[**Frappe Framework**](https://github.com/frappe/frappe): A full-stack web application framework written in Python and Javascript. The framework provides a robust foundation for building web applications, including a database abstraction layer, user authentication, and a REST API.
81
+
### Under the Hood
56
82
57
-
-[**Frappe UI**](https://github.com/frappe/frappe-ui): A Vue-based UI library, to provide a modern user interface. The Frappe UI library provides a variety of components that can be used to build single-page applications on top of the Frappe Framework.
83
+
-[Frappe Framework](https://github.com/frappe/frappe): A full-stack web application framework.
84
+
-[Frappe UI](https://github.com/frappe/frappe-ui): A Vue-based UI library, to provide a modern user interface.
58
85
59
-
## Production Setup
86
+
## Getting Started (Production)
60
87
61
88
### Managed Hosting
62
89
63
-
You can try [Frappe Cloud](https://frappecloud.com), a simple, user-friendly and sophisticated [open-source](https://github.com/frappe/press) platform to host Frappe applications with peace of mind.
64
-
65
-
It takes care of installation, setup, upgrades, monitoring, maintenance and support of your Frappe deployments. It is a fully featured developer platform with an ability to manage and control multiple Frappe deployments.
66
-
90
+
Get started with your personal or business site with a few clicks on Frappe Cloud - our official hosting service.
1. Access the crm page at `sitename.localhost:8000/crm`in your web browser.
142
+
143
+
**For Frontend Development**
144
+
1. Open a new terminal session and cd into `frappe-bench/apps/crm`, and run the following commands:
145
+
```
146
+
yarn install
147
+
yarn dev
148
+
```
149
+
1. Now, you can access the site on vite dev server at `http://sitename.localhost:8080`
150
+
151
+
**Note:** You'll find all the code related to Frappe CRM's frontend inside `frappe-bench/apps/crm/frontend`
106
152
107
153
### Docker
108
154
@@ -128,72 +174,15 @@ You need Docker, docker-compose and git setup on your machine. Refer [Docker doc
128
174
- Username: Administrator
129
175
- Password: admin
130
176
131
-
### Codespaces
132
-
133
-
1. Open [this link](https://github.com/codespaces/new?hide_repo_select=true&ref=master&repo=668199241&skip_quickstart=true&machine=standardLinux32gb&devcontainer_path=.devcontainer%2Fdevcontainer.json&geo=SoutheastAsia) and click on "Create Codespace".
134
-
2. Wait for initialization (~15 mins).
135
-
3. Run `bench start` from the terminal tab.
136
-
4. Click on the link beside "8000" port under "Ports" tab.
137
-
5. Log in with "Administrator" as the username and "admin" as the password.
138
-
6. Go to `<random-id>.github.dev/crm` to access the crm interface.
5. Access the crm page at `sitename.localhost:8000/crm`in your web browser.
156
-
157
-
### Frontend Development Setup
158
-
159
-
The Frappe CRM's frontend is a Vue.js application located in the `frontend/src` directory. Follow these steps to set up the frontend development environment:
160
-
161
-
1. Navigate to the app directory:
162
-
163
-
```bash
164
-
cd apps/crm
165
-
```
166
-
167
-
2. Install dependencies:
168
-
169
-
```bash
170
-
yarn install
171
-
```
172
-
173
-
3. Add the following line in your site's `site_config.json` file
174
-
175
-
```json
176
-
"ignore_csrf": 1
177
-
```
178
-
179
-
4. Start the development server:
180
-
181
-
```bash
182
-
yarn dev
183
-
```
184
-
185
-
5. Access the development site:
186
-
- Open `http://crm.localhost:8080/crm`in your browser
187
-
- Any changes to files in`frontend/src` will automatically reload in the browser
0 commit comments