Skip to content
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.

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

chore: update readme for Next CRM #41

Merged
merged 1 commit into from
Nov 25, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Binary file modified .github/logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed .github/screenshots/CallLogs.png
Binary file not shown.
Binary file removed .github/screenshots/CallUI.png
Binary file not shown.
Binary file removed .github/screenshots/DealsList.png
Binary file not shown.
Binary file removed .github/screenshots/Emailtemplates.png
Binary file not shown.
Binary file removed .github/screenshots/LeadPage.png
Binary file not shown.
Binary file removed .github/screenshots/MainDealPage.png
Binary file not shown.
Binary file added .github/screenshots/OpportunityPage.jpeg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
92 changes: 13 additions & 79 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,27 +1,20 @@
<div align="center">
<img width="60" src=".github/logo.png" alt="Next CRM Logo">
<h1>Next CRM</h1>
</div>

<div align="center">
<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 width="800" alt="Screenshot of Opportunity page" src=".github/screenshots/OpportunityPage.jpeg">
</a>
</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>

<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>

## Key Features

- **Views:** Create custom views which is a combination of filters, sort and columns.
Expand All @@ -34,92 +27,33 @@
- **Notifications:** Get notified when someone mentions you in a comment.
- **Service Level Agreement:** Set SLA for leads and deals and get notified when the SLA is breached.
- **Assignment Rule:** Automatically assign leads and deals to users based on the criteria.
- **Tasks:** Create tasks for leads and deals.
- **ToDos:** Create todos for leads and deals.
- **Notes:** Add notes to leads and deals.
- **Call Logs:** See the call logs with call details and recordings.

## Integrations

- **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.

## Getting Started

### Managed Hosting

Get started with your personal or business site with a few clicks on [Frappe Cloud](https://frappecloud.com/marketplace/apps/crm).

### Docker (Recommended)

The quickest way to set up Next CRM and take it for a test ride.

Frappe framework is multi-tenant and supports multiple apps by default. This docker compose is just a standalone version with Next CRM pre-installed. Just put it behind your desired reverse-proxy if needed, and you're good to go.

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.

**Step 1**: Setup folder and download the required files

mkdir frappe-crm
cd frappe-crm

**Step 2**: Download the required files

Docker Compose File:

wget -O docker-compose.yml https://raw.githubusercontent.com/frappe/crm/develop/docker/docker-compose.yml

Next CRM bench setup script

wget -O init.sh https://raw.githubusercontent.com/frappe/crm/develop/docker/init.sh

**Step 3**: 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:

> 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?

### Codespaces

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".
2. Wait for initialization (~15 mins).
3. Run `bench start` from the terminal tab.
4. Click on the link beside "8000" port under "Ports" tab.
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

1. [Install Bench](https://github.com/frappe/bench).
2. Install Next CRM app:
2. [Install ERPNext](https://github.com/frappe/erpnext)
2. Get the Next CRM app:
```sh
$ bench get-app crm
$ bench get-app https://github.com/rtCamp/next-crm --branch next-develop
```
3. Create a site with the crm app:
```sh
$ bench --site sitename.localhost install-app crm
$ bench --site sitename.localhost install-app next_crm
```
4. Open the site in the browser:
```sh
$ bench browse sitename.localhost --user Administrator
```
5. Access the crm page at `sitename.localhost:8000/crm` in your web browser.
5. Access the crm page at `sitename.localhost:8000/next-crm` in your web browser.

## Need help?

Join our [telegram group](https://t.me/frappecrm) for instant help.

## Documentation

Check out the [official documentation](https://docs.frappe.io/crm) for more details.
Reach out to us at [[email protected]](mailto:[email protected]) for help.

## License

Expand Down