-
-> **Note:** We are currently not accepting any contributions to this repository, but you can always open an issue if you find any bugs, feature requests, or have any suggestions.
-
+
+
+
+
+
+
Modern, open-source, CRM solution to supercharge your sales operations.
+
+
+
+
+
+
-
- Show more screenshots
+# Frappe CRM
-
+Frappe CRM is modern, open-source, CRM solution to supercharge your sales operations.
-
+## Key Features
-
-
-
-
+- **Views:** Create custom views which is a combination of filters, sort and columns.
+ - **Pinned View:** Pin important leads and deals in the sidebar.
+ - **Public View:** Share views to all users.
+ - **Saved View:** Save views for later use.
+- **Email Communication:** Send and receive emails directly from the Lead/Deal Page.
+- **Email Templates:** Create and use email templates for faster communication.
+- **Comments:** Add comments to leads and deals to keep track of the conversation.
+- **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.
+- **Notes:** Add notes to leads and deals.
+- **Call Logs:** See the call logs with call details and recording.
+- **Twilio Ingegration:** Integrate Twilio to make and receive calls from the CRM.
## Getting Started
-Currently, this app depends on the `develop` branch of [frappe](https://github.com/frappe/frappe).
+### Self-hosting
-1. Setup frappe-bench by following [this guide](https://frappeframework.com/docs/v14/user/en/installation)
-1. In the frappe-bench directory, run `bench start` and keep it running. Open a new terminal session and cd into `frappe-bench` directory.
-1. Run the following commands:
+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=587413812&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 `.github.dev/crm` to access the crm interface.
+
+### Local Setup
+
+1. [Install Bench](https://github.com/frappe/bench).
+2. Install Frappe CRM app:
```sh
- bench new-site crm.test
- bench get-app crm
- bench --site crm.test install-app crm
- bench --site crm.test add-to-hosts
- bench --site crm.test browse --user Administrator
+ $ bench get-app crm
```
- 1. Now, open a new terminal session and cd into `frappe-bench/apps/crm`, and run the following commands:
+3. Create a site with the crm app:
+ ```sh
+ $ bench --site sitename.localhost install-app crm
```
- yarn
- yarn dev
+4. Open the site in the browser:
+ ```sh
+ $ bench browse sitename.localhost --user Administrator
```
- 1. Now, you can access the site on vite dev server at `http://crm.test:8080`
\ No newline at end of file
+5. Access the crm page at `sitename.localhost:8000/crm` in your web browser.
+
+## Need help?
+
+Join our [telegram group](https://t.me/frappecrm) for instant help.
+
+## License
+
+[GNU Affero General Public License v3.0](LICENSE)
\ No newline at end of file