|
1 | 1 | <div align="center" markdown="1"> |
2 | | - <a href="https://frappedesk.com/"> |
3 | | - <img src=".github/hd-logo.svg" height="128" alt="Frappe Helpdesk Logo"> |
4 | | - </a> |
5 | | - <h2>Frappe Helpdesk</h2> |
6 | | - <p align="center"> |
7 | | - <p>Modern, Streamlined, Customer Service Software</p> |
8 | | - </p> |
9 | | - |
10 | | -[frappedesk.com](https://frappedesk.com) |
11 | | - |
12 | | -<div align="center" style="max-height: 40px;"> |
13 | | - <a href="https://frappecloud.com/helpdesk/signup"> |
14 | | - <img src=".github/try-on-f-cloud-button.svg" height="50"> |
15 | | - </a> |
| 2 | + |
| 3 | +<img src=".github/hd-logo.svg" alt="Frappe Helpdesk logo" width="100"/> |
| 4 | +<h1>Frappe Helpdesk</h1> |
| 5 | + |
| 6 | +**Open Source Business Intelligence Tool** |
| 7 | + |
| 8 | + |
| 9 | +[](https://codecov.io/github/frappe/helpdesk) |
| 10 | + |
16 | 11 | </div> |
| 12 | + |
| 13 | + |
| 14 | +<div align="center"> |
| 15 | + <img src="./screenshot.webp" alt="Hero Image" width="72%" /> |
| 16 | +</div> |
| 17 | +<br /> |
| 18 | +<div align="center"> |
| 19 | + <a href="https://frappe.io/helpdesk">Website</a> |
| 20 | + - |
| 21 | + <a href="https://docs.frappe.io/helpdesk">Documentation</a> |
17 | 22 | </div> |
18 | 23 |
|
19 | | ---- |
| 24 | +## Frappe Helpdesk |
| 25 | +Frappe Helpdesk is an 100% open-source Ticket Management tool which helps you streamline your company's support, offers an easy setup, clean user interface, and automation tools to resolve customer queries efficiently. |
| 26 | + |
| 27 | + |
| 28 | + |
| 29 | +## Motivation |
| 30 | +Managing issues from our customers was a big challenge for us. We were using the ERPNext support module which was not very good in UI and the UX was also not good. We wanted to have a tool that can be easily integrated with our existing system and can be customized as per our needs. So we decided to build a Helpdesk tool that can be easily integrated with our existing system and can be customized as per our needs. |
20 | 31 |
|
21 | | -Frappe Helpdesk offers an easy setup, clean user interface, and automation tools to resolve customer issues efficiently. It is based on Frappe Framework. It lets you streamline your company's support and helps you to efficiently manage your customer queries. It can help you to, |
| 32 | +## Key Features |
22 | 33 |
|
23 | | -- Create tickets from email or help center |
24 | | -- Empower customers with a comprehensive knowledge base and self-service portal |
25 | | -- Automate redundant tasks like agent assignment and set up triggers to notify agents and customers based on certain events |
| 34 | +- **Agent and Customer Portal Views**: Dual portals for agents and customers to simplify issue submission and management. |
26 | 35 |
|
27 | | - |
| 36 | +- **Customizable SLAs**: Discover how you can set and track SLAs for better response times. |
28 | 37 |
|
29 | | -## Installation |
| 38 | +- **Assignment Rules**: Custom auto-assignment of tickets based on priority, issue type, or workload. |
30 | 39 |
|
31 | | -1. Install and setup bench by following [this guide](https://frappeframework.com/docs/user/en/installation) |
32 | | -2. In the bench directory, run `bench start` and keep it running |
33 | | -3. Open another terminal in bench directory, and run these commands |
| 40 | +- **Email Account Setup**: Set up email accounts to automatically create tickets from incoming emails. Choose from various Mail providers like Frappe Mail, Gmail, Outlook, Sendgrid, Sparkpost, Yahoo, Yandex, etc. |
34 | 41 |
|
35 | | - ``` |
36 | | - bench get-app helpdesk |
37 | | - bench new-site helpdesk.test |
38 | | - bench --site helpdesk.test install-app helpdesk |
39 | | - bench --site helpdesk.test add-to-hosts |
40 | | - ``` |
| 42 | +- **Canned Responses**: Pre-written replies for common queries to ensure quick and consistent communication. |
41 | 43 |
|
42 | | - You can now access Helpdesk at `http://helpdesk.test` |
43 | | -5. You can also run a development server by following theses steps, in Helpdesk |
44 | | - directory (`apps/helpdesk`) |
| 44 | +- **Knowledge Base**: Learn how to create and manage help articles to empower users and reduce tickets. |
45 | 45 |
|
46 | | - ``` |
47 | | - yarn |
48 | | - yarn dev |
49 | | - ``` |
50 | 46 |
|
51 | | - Development server will be now available at `http://localhost:8080` |
52 | 47 |
|
53 | | -## Contributions and Community |
| 48 | +<details> |
| 49 | +<summary>Screenshots</summary> |
54 | 50 |
|
55 | | -There are many ways you can contribute even if you don't code: |
| 51 | + |
| 52 | + |
| 53 | + |
| 54 | +</details> |
| 55 | + |
| 56 | + |
| 57 | +## Under the Hood |
| 58 | + |
| 59 | +- [**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. |
| 60 | + |
| 61 | +- [**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. |
| 62 | + |
| 63 | + |
| 64 | +## Production Setup |
| 65 | + |
| 66 | +### Managed Hosting |
| 67 | + |
| 68 | +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. |
| 69 | + |
| 70 | +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. |
| 71 | + |
| 72 | +<div> |
| 73 | + <a href="https://frappecloud.com/helpdesk/signup" target="_blank"> |
| 74 | + <picture> |
| 75 | + <source media="(prefers-color-scheme: dark)" srcset="https://frappe.io/files/try-on-fc-white.png"> |
| 76 | + <img src="https://frappe.io/files/try-on-fc-black.png" alt="Try on Frappe Cloud" height="28" /> |
| 77 | + </picture> |
| 78 | + </a> |
| 79 | +</div> |
56 | 80 |
|
57 | | -1. You can start by giving a star to this repository! |
58 | | -2. If you find any issues, even if it is a typo, you can [raise an issue](https://github.com/frappe/desk/issues/new) to inform us. |
59 | | -3. Join our [Telegram group](https://t.me/frappedesk) and share your thoughts. |
| 81 | +### Self Hosting |
60 | 82 |
|
61 | | -## License |
| 83 | +Follow these steps to set up Frappe Helpdesk in production: |
62 | 84 |
|
63 | | -[GNU Affero General Public License v3.0](/licence.md) |
| 85 | +**Step 1**: Download the easy install script |
| 86 | + |
| 87 | +```bash |
| 88 | +wget https://frappe.io/easy-install.py |
| 89 | +``` |
| 90 | + |
| 91 | +**Step 2**: Run the deployment command |
| 92 | + |
| 93 | +```bash |
| 94 | +python3 ./easy-install.py deploy \ |
| 95 | + --project=helpdesk_prod_setup \ |
| 96 | + --email=your_email.example.com \ |
| 97 | + --image=ghcr.io/frappe/helpdesk \ |
| 98 | + --version=stable \ |
| 99 | + --app=helpdesk \ |
| 100 | + --sitename subdomain.domain.tld |
| 101 | +``` |
| 102 | + |
| 103 | +Replace the following parameters with your values: |
| 104 | +- `your_email.example.com`: Your email address |
| 105 | +- `subdomain.domain.tld`: Your domain name where Helpdesk will be hosted |
| 106 | + |
| 107 | +The script will set up a production-ready instance of Frappe Helpdesk with all the necessary configurations in about 5 minutes. |
| 108 | + |
| 109 | +## Development Setup |
| 110 | + |
| 111 | +### Docker |
| 112 | + |
| 113 | +You need Docker, docker-compose and git setup on your machine. Refer [Docker documentation](https://docs.docker.com/). After that, follow below steps: |
| 114 | + |
| 115 | +**Step 1**: Setup folder and download the required files |
| 116 | + |
| 117 | + mkdir frappe-helpdesk |
| 118 | + cd frappe-helpdesk |
| 119 | + |
| 120 | + # Download the docker-compose file |
| 121 | + wget -O docker-compose.yml https://raw.githubusercontent.com/frappe/helpdesk/develop/docker/docker-compose.yml |
| 122 | + |
| 123 | + # Download the setup script |
| 124 | + wget -O init.sh https://raw.githubusercontent.com/frappe/helpdesk/develop/docker/init.sh |
| 125 | + |
| 126 | +**Step 2**: Run the container and daemonize it |
| 127 | + |
| 128 | + docker compose up -d |
| 129 | + |
| 130 | +**Step 3**: The site [http://helpdesk.localhost:8000/helpdesk](http://helpdesk.localhost:8000/helpdesk) should now be available. The default credentials are: |
| 131 | +- Username: Administrator |
| 132 | +- Password: admin |
| 133 | + |
| 134 | +### Local |
| 135 | + |
| 136 | +To setup the repository locally follow the steps mentioned below: |
| 137 | + |
| 138 | +1. Install bench and setup a `frappe-bench` directory by following the [Installation Steps](https://frappeframework.com/docs/user/en/installation) |
| 139 | +1. Start the server by running `bench start` |
| 140 | +1. In a separate terminal window, create a new site by running `bench new-site helpdesk.test` |
| 141 | +1. Map your site to localhost with the command `bench --site helpdesk.test add-to-hosts` |
| 142 | +1. Get the Helpdesk app. Run `bench get-app https://github.com/frappe/helpdesk` |
| 143 | +1. Run `bench --site helpdesk.test install-app helpdesk`. |
| 144 | +1. Now open the URL `http://helpdesk.test:8000/helpdesk` in your browser, you should see the app running |
| 145 | + |
| 146 | +## Learn and connect |
| 147 | + |
| 148 | +- [Telegram Public Group](https://t.me/frappedesk) |
| 149 | +- [Discuss Forum](https://discuss.frappe.io/c/frappehelpdesk/69) |
| 150 | +- [Documentation](https://docs.frappe.io/helpdesk) |
| 151 | +- [YouTube]([https://frappe.io](https://www.youtube.com/@frappetech)) |
| 152 | + |
| 153 | +<h2></h2> |
| 154 | +<div align="center" style="padding-top: 0.75rem;"> |
| 155 | + <a href="https://frappe.io" target="_blank"> |
| 156 | + <picture> |
| 157 | + <source media="(prefers-color-scheme: dark)" srcset="https://frappe.io/files/Frappe-white.png"> |
| 158 | + <img src="https://frappe.io/files/Frappe-black.png" alt="Frappe Technologies" height="28"/> |
| 159 | + </picture> |
| 160 | + </a> |
| 161 | +</div> |
0 commit comments