-
Notifications
You must be signed in to change notification settings - Fork 271
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'develop' into fix/subcategory-dialog-initial-load-values
- Loading branch information
Showing
261 changed files
with
14,325 additions
and
4,857 deletions.
There are no files selected for viewing
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,63 +1,196 @@ | ||
<div align="center" markdown="1"> | ||
<a href="https://frappedesk.com/"> | ||
<img src=".github/hd-logo.svg" height="128" alt="Frappe Helpdesk Logo"> | ||
</a> | ||
<h2>Frappe Helpdesk</h2> | ||
<p align="center"> | ||
<p>Modern, Streamlined, Customer Service Software</p> | ||
</p> | ||
|
||
[frappedesk.com](https://frappedesk.com) | ||
|
||
<div align="center" style="max-height: 40px;"> | ||
<a href="https://frappecloud.com/helpdesk/signup"> | ||
<img src=".github/try-on-f-cloud-button.svg" height="50"> | ||
</a> | ||
|
||
<img src=".github/hd-logo.svg" alt="Frappe Helpdesk logo" width="80"/> | ||
<h1>Frappe Helpdesk</h1> | ||
|
||
**Customer Service, Made Simple and Effective** | ||
|
||
![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) | ||
|
||
|
||
</div> | ||
|
||
|
||
<div align="center"> | ||
<img src="./.github/Hero2.png" alt="Hero Image" width="100%" /> | ||
</div> | ||
<br /> | ||
<div align="center"> | ||
<a href="https://frappe.io/helpdesk">Website</a> | ||
- | ||
<a href="https://docs.frappe.io/helpdesk">Documentation</a> | ||
</div> | ||
|
||
--- | ||
## Frappe Helpdesk | ||
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. | ||
|
||
|
||
|
||
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, | ||
### 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. | ||
|
||
- Create tickets from email or help center | ||
- Empower customers with a comprehensive knowledge base and self-service portal | ||
- Automate redundant tasks like agent assignment and set up triggers to notify agents and customers based on certain events | ||
### Key Features | ||
|
||
![screenshot](./screenshot.webp) | ||
- **Agent and Customer Portal Views**: Dual portals for agents and customers to simplify issue submission and management. | ||
|
||
## Installation | ||
- **Customizable SLAs**: Discover how you can set and track SLAs for better response times. | ||
|
||
1. Install and setup bench by following [this guide](https://frappeframework.com/docs/user/en/installation) | ||
2. In the bench directory, run `bench start` and keep it running | ||
3. Open another terminal in bench directory, and run these commands | ||
- **Assignment Rules**: Custom auto-assignment of tickets based on priority, issue type, or workload. | ||
|
||
``` | ||
bench get-app helpdesk | ||
bench new-site helpdesk.test | ||
bench --site helpdesk.test install-app helpdesk | ||
bench --site helpdesk.test add-to-hosts | ||
``` | ||
- **Knowledge Base**: Learn how to create and manage help articles to empower users and reduce tickets. | ||
|
||
You can now access Helpdesk at `http://helpdesk.test` | ||
5. You can also run a development server by following theses steps, in Helpdesk | ||
directory (`apps/helpdesk`) | ||
- **Canned Responses**: Pre-written replies for common queries to ensure quick and consistent communication. | ||
|
||
``` | ||
yarn | ||
yarn dev | ||
``` | ||
<details open> | ||
<summary >View Screenshots</summary> | ||
<h3></h3> | ||
|
||
Development server will be now available at `http://localhost:8080` | ||
<div align="center"> | ||
<sub> | ||
Agent List View | ||
</sub> | ||
</div> | ||
|
||
![Agent List View](.github/AgentListView.png) | ||
|
||
## Contributions and Community | ||
|
||
There are many ways you can contribute even if you don't code: | ||
<div align="center"> | ||
<sub> | ||
Upload articles and let your customer solve there queries through the Knowledge Base. | ||
</sub> | ||
</div> | ||
|
||
1. You can start by giving a star to this repository! | ||
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. | ||
3. Join our [Telegram group](https://t.me/frappedesk) and share your thoughts. | ||
![Knowledge Base](.github/KB.png) | ||
|
||
## License | ||
<div align="center"> | ||
<sub> | ||
With advanced search, your customers will be recommended relevant articles regarding their issue. | ||
</sub> | ||
</div> | ||
|
||
[GNU Affero General Public License v3.0](/licence.md) | ||
|
||
![Article Search](.github/Search2.png) | ||
|
||
|
||
|
||
</details> | ||
<br> | ||
|
||
|
||
### 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 | ||
|
||
### Managed Hosting | ||
|
||
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. | ||
|
||
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. | ||
|
||
<div> | ||
<a href="https://frappecloud.com/helpdesk/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> | ||
|
||
### Self Hosting | ||
|
||
Follow these steps to set up Frappe Helpdesk 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=helpdesk_prod_setup \ | ||
--email=your_email.example.com \ | ||
--image=ghcr.io/frappe/helpdesk \ | ||
--version=stable \ | ||
--app=helpdesk \ | ||
--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 Helpdesk will be hosted | ||
|
||
The script will set up a production-ready instance of Frappe Helpdesk 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-helpdesk | ||
cd frappe-helpdesk | ||
|
||
# Download the docker-compose file | ||
wget -O docker-compose.yml https://raw.githubusercontent.com/frappe/helpdesk/develop/docker/docker-compose.yml | ||
|
||
# Download the setup script | ||
wget -O init.sh https://raw.githubusercontent.com/frappe/helpdesk/develop/docker/init.sh | ||
|
||
**Step 2**: Run the container and daemonize it | ||
|
||
docker compose up -d | ||
|
||
**Step 3**: The site [http://helpdesk.localhost:8000/helpdesk](http://helpdesk.localhost:8000/helpdesk) should now be available. The default credentials are: | ||
- Username: Administrator | ||
- Password: admin | ||
|
||
### Local | ||
|
||
To setup the repository locally follow the steps mentioned below: | ||
|
||
1. Install bench and setup a `frappe-bench` directory by following the [Installation Steps](https://frappeframework.com/docs/user/en/installation) | ||
1. Start the server by running `bench start` | ||
1. In a separate terminal window, create a new site by running `bench new-site helpdesk.test` | ||
1. Map your site to localhost with the command `bench --site helpdesk.test add-to-hosts` | ||
1. Get the Helpdesk app. Run `bench get-app https://github.com/frappe/helpdesk` | ||
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) | ||
<br> | ||
<br> | ||
<div align="center"> | ||
<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> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -3,6 +3,7 @@ node_modules | |
dist | ||
dist-ssr | ||
*.local | ||
dev-dist | ||
|
||
# local env files | ||
.env.local | ||
|
Oops, something went wrong.