diff --git a/.github/AgentListView.png b/.github/AgentListView.png new file mode 100644 index 000000000..51836f92e Binary files /dev/null and b/.github/AgentListView.png differ diff --git a/.github/Hero2.png b/.github/Hero2.png new file mode 100644 index 000000000..40cdd664d Binary files /dev/null and b/.github/Hero2.png differ diff --git a/.github/KB.png b/.github/KB.png new file mode 100644 index 000000000..42f1598f3 Binary files /dev/null and b/.github/KB.png differ diff --git a/.github/Search2.png b/.github/Search2.png new file mode 100644 index 000000000..b79cb6a0e Binary files /dev/null and b/.github/Search2.png differ diff --git a/README.md b/README.md index c38e50521..4f339f3ba 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@
-Frappe Helpdesk logo +Frappe Helpdesk logo

Frappe Helpdesk

**Customer Service, Made Simple and Effective** @@ -8,11 +8,12 @@ ![GitHub release (latest by date)](https://img.shields.io/github/v/release/frappe/helpdesk) [![codecov](https://codecov.io/github/frappe/helpdesk/branch/develop/graph/badge.svg?token=8ZXHCY4G9U)](https://codecov.io/github/frappe/helpdesk) +
- Hero Image + Hero Image

@@ -26,10 +27,10 @@ Frappe Helpdesk is an 100% open-source Ticket Management tool which helps you s -## Motivation +### Motivation 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 Frappe Helpdesk. -## Key Features +### Key Features - **Agent and Customer Portal Views**: Dual portals for agents and customers to simplify issue submission and management. @@ -37,19 +38,51 @@ Managing issues from our customers was a big challenge for us. We were using the - **Assignment Rules**: Custom auto-assignment of tickets based on priority, issue type, or workload. -- **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. +- **Knowledge Base**: Learn how to create and manage help articles to empower users and reduce tickets. - **Canned Responses**: Pre-written replies for common queries to ensure quick and consistent communication. -- **Knowledge Base**: Learn how to create and manage help articles to empower users and reduce tickets. +
+View Screenshots +

+ +
+ + Agent List View + +
+ +![Agent List View](.github/AgentListView.png) +
+ + Upload articles and let your customer solve there queries through the Knowledge Base. + +
+ +![Knowledge Base](.github/KB.png) + +
+ + With advanced search, your customers will be recommended relevant articles regarding their issue. + +
-## 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. +![Article Search](.github/Search2.png) -- [**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. + + +
+
+ + +### Under the Hood + +- [**Frappe Framework**](https://github.com/frappe/frappe): A full-stack web application framework written in Python and Javascript. + +- [**Frappe UI**](https://github.com/frappe/frappe-ui): A Vue-based UI library, to provide a modern user interface. ## Production Setup @@ -134,15 +167,26 @@ To setup the repository locally follow the steps mentioned below: 1. Run `bench --site helpdesk.test install-app helpdesk`. 1. Now open the URL `http://helpdesk.test:8000/helpdesk` in your browser, you should see the app running + +**For Frontend Development** +1. Open a new terminal session and cd into `frappe-bench/apps/helpdesk/desk`, and run the following commands: + ``` + yarn install + yarn dev or yarn dev --host helpdesk.test + ``` +1. Now, you can access the site on vite dev server at `http://helpdesk.test:8080` + +**Note:** You'll find all the code related to Helpdesk's frontend inside `frappe-bench/apps/helpdesk/desk` + ## Learn and connect - [Telegram Public Group](https://t.me/frappedesk) - [Discuss Forum](https://discuss.frappe.io/c/frappehelpdesk/69) - [Documentation](https://docs.frappe.io/helpdesk) -


-
+
+
diff --git a/desk/src/App.vue b/desk/src/App.vue index 4d0c467f1..bebc1e316 100644 --- a/desk/src/App.vue +++ b/desk/src/App.vue @@ -1,5 +1,5 @@