chore: updated README

This commit is contained in:
Shariq Ansari 2024-12-10 21:34:46 +05:30
parent f5df45b44e
commit bf2051537b
10 changed files with 111 additions and 53 deletions

4
.github/logo.svg vendored Normal file
View File

@ -0,0 +1,4 @@
<svg width="300" height="300" viewBox="0 0 300 300" fill="none" xmlns="http://www.w3.org/2000/svg">
<path d="M214.286 0H85.7143C38.3756 0 0 38.3756 0 85.7143V214.286C0 261.624 38.3756 300 85.7143 300H214.286C261.624 300 300 261.624 300 214.286V85.7143C300 38.3756 261.624 0 214.286 0Z" fill="#EF0BF5"/>
<path d="M64.2141 90.301V111.862H214.339V140.214L160.187 193.146V208.993L139.705 208.885V193.146L85.6605 140.214H64.2141V149.269L118.259 202.202V230.23L181.634 230.769V202.202L235.786 149.269V90.301H64.2141Z" fill="white"/>
</svg>

After

Width:  |  Height:  |  Size: 534 B

BIN
.github/screenshots/CallLog.png vendored Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.0 MiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 1.2 MiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 1.1 MiB

After

Width:  |  Height:  |  Size: 1.1 MiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 1.1 MiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 1.1 MiB

After

Width:  |  Height:  |  Size: 957 KiB

BIN
.github/screenshots/FrappeCRMHero.png vendored Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 884 KiB

BIN
.github/screenshots/LeadList.png vendored Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.1 MiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 1023 KiB

After

Width:  |  Height:  |  Size: 970 KiB

154
README.md
View File

@ -1,26 +1,29 @@
<div align="center">
<div align="center" markdown="1">
<a href="https://frappe.io/products/crm">
<img width="1402" alt="Screenshot 2022-09-18 at 9 16 08 PM" src=".github/screenshots/MainDealPage.png">
<img src=".github/logo.svg" height="100" alt="Frappe CRM Logo">
</a>
<h1>Frappe CRM</h1>
**Simplify Sales, Amplify Relationships**
![GitHub release (latest by date)](https://img.shields.io/github/v/release/frappe/crm)
![Issues](https://img.shields.io/github/issues/frappe/crm)
![License](https://img.shields.io/github/license/frappe/crm)
![Stars](https://img.shields.io/github/stars/frappe/crm)
![Frappe CRM](.github/screenshots/FrappeCRMHero.png)
[Live Demo](https://frappecrm-demo.frappe.cloud/api/method/crm.api.demo.login) - [Website](https://frappe.io/crm) - [Documentation](https://docs.frappe.io/crm)
</div>
<p align="center">
<a href="https://img.shields.io/github/issues/frappe/crm">
<img alt="issues" src="https://img.shields.io/github/issues/frappe/crm">
</a>
<a href="https://img.shields.io/github/license/frappe/crm">
<img alt="license" src="https://img.shields.io/github/license/frappe/crm">
</a>
</p>
## Frappe CRM
<details>
<summary>Show more screenshots</summary>
<img width="1402" alt="Screenshot 2022-09-18 at 9 18 17 PM" src=".github/screenshots/DealsList.png">
<img width="1402" alt="Screenshot 2022-09-18 at 11 47 06 PM" src=".github/screenshots/LeadPage.png">
<img width="1402" alt="Screenshot 2022-09-18 at 9 18 47 PM" src=".github/screenshots/Emailtemplates.png">
<img width="1402" alt="Screenshot 2022-09-18 at 9 18 47 PM" src=".github/screenshots/CallUI.png">
<img width="1402" alt="Screenshot 2022-09-18 at 9 18 47 PM" src=".github/screenshots/CallLogs.png">
</details>
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.
## Motivation
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.
## Key Features
@ -42,50 +45,96 @@
- **Twilio:** Integrate Twilio to make and receive calls from the CRM. You can also record calls. It is a built-in integration.
- **WhatsApp:** Integrate WhatsApp to send and receive messages from the CRM. [Frappe WhatsApp](https://github.com/shridarpatil/frappe_whatsapp) is used for this integration.
- **ERPNext:** Integrate with [ERPNext](https://erpnext.com) to extend the CRM capabilities to include invoicing, accounting, and more.
## Getting Started
<details>
<summary>Screenshots</summary>
![Deals List](.github/screenshots/LeadList.png)
![Lead Page](.github/screenshots/LeadPage.png)
![Email Templates](.github/screenshots/EmailTemplates.png)
![Call UI](.github/screenshots/CallUI.png)
![Call Logs](.github/screenshots/CallLog.png)
</details>
## Under the Hood
- [**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.
- [**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.
## Production Setup
### Managed Hosting
Get started with your personal or business site with a few clicks on [Frappe Cloud](https://frappecloud.com/marketplace/apps/crm).
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.
### Docker (Recommended)
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.
The quickest way to set up Frappe CRM and take it for a test ride.
<div>
<a href="https://frappecloud.com/crm/signup" target="_blank">
<picture>
<source media="(prefers-color-scheme: dark)" srcset="https://frappe.io/files/try-on-fc-white.png">
<img src="https://frappe.io/files/try-on-fc-black.png" alt="Try on Frappe Cloud" height="28" />
</picture>
</a>
</div>
Frappe framework is multi-tenant and supports multiple apps by default. This docker compose is just a standalone version with Frappe CRM pre-installed. Just put it behind your desired reverse-proxy if needed, and you're good to go.
### Self Hosting
If you wish to use multiple Frappe apps or need multi-tenancy. Take a look at our production ready self-hosted workflow, or join us on Frappe Cloud to get first party support and hassle-free hosting.
Follow these steps to set up Frappe CRM in production:
**Step 1**: Download the easy install script
```bash
wget https://frappe.io/easy-install.py
```
**Step 2**: Run the deployment command
```bash
python3 ./easy-install.py deploy \
--project=crm_prod_setup \
--email=your_email.example.com \
--image=ghcr.io/frappe/crm \
--version=stable \
--app=crm \
--sitename subdomain.domain.tld
```
Replace the following parameters with your values:
- `your_email.example.com`: Your email address
- `subdomain.domain.tld`: Your domain name where CRM will be hosted
The script will set up a production-ready instance of Frappe CRM with all the necessary configurations in about 5 minutes.
## Development Setup
### Docker
You need Docker, docker-compose and git setup on your machine. Refer [Docker documentation](https://docs.docker.com/). After that, follow below steps:
**Step 1**: Setup folder and download the required files
mkdir frappe-crm
cd frappe-crm
**Step 2**: Download the required files
Docker Compose File:
# Download the docker-compose file
wget -O docker-compose.yml https://raw.githubusercontent.com/frappe/crm/develop/docker/docker-compose.yml
Frappe CRM bench setup script
# Download the setup script
wget -O init.sh https://raw.githubusercontent.com/frappe/crm/develop/docker/init.sh
**Step 3**: Run the container and daemonize it
**Step 2**: Run the container and daemonize it
docker compose up -d
**Step 4**: The site [http://crm.localhost](http://crm.localhost) should now be available. The default credentials are:
**Step 3**: The site [http://crm.localhost:8000/crm](http://crm.localhost:8000/crm) should now be available. The default credentials are:
> username: administrator
> password: admin
### Self-hosting
If you prefer self-hosting, follow the official [Frappe Bench Installation](https://github.com/frappe/bench#installation) instructions.
## Want to Just Try Out or Contribute?
- Username: Administrator
- Password: admin
### Codespaces
@ -96,7 +145,7 @@ If you prefer self-hosting, follow the official [Frappe Bench Installation](http
5. Log in with "Administrator" as the username and "admin" as the password.
6. Go to `<random-id>.github.dev/crm` to access the crm interface.
### Local Setup
### Local
1. [Install Bench](https://github.com/frappe/bench).
2. Install Frappe CRM app:
@ -113,14 +162,19 @@ If you prefer self-hosting, follow the official [Frappe Bench Installation](http
```
5. Access the crm page at `sitename.localhost:8000/crm` in your web browser.
## Need help?
## Learn and connect
Join our [telegram group](https://t.me/frappecrm) for instant help.
- [Telegram Public Group](https://t.me/frappecrm)
- [Discuss Forum](https://discuss.frappe.io/c/frappe-crm)
- [Documentation](https://docs.frappe.io/crm)
- [YouTube](https://frappe.io)
## Documentation
Check out the [official documentation](https://docs.frappe.io/crm) for more details.
## License
[GNU Affero General Public License v3.0](LICENSE)
<h2></h2>
<div align="center" style="padding-top: 0.75rem;">
<a href="https://frappe.io" target="_blank">
<picture>
<source media="(prefers-color-scheme: dark)" srcset="https://frappe.io/files/Frappe-white.png">
<img src="https://frappe.io/files/Frappe-black.png" alt="Frappe Technologies" height="28"/>
</picture>
</a>
</div>