Merge pull request #1080 from ssiyad/refactor/rebrand

rebrand: `frappedesk` -> `helpdesk`

.github/workflows/server-tests.yml

@@ -113,7 +113,7 @@ jobs:
  FRAPPE_BRANCH: ${{ github.event.inputs.branch }}
 
  - name: Run Tests
- run: 'cd ~/frappe-bench/ && bench --site test_site run-tests --app frappedesk --coverage'
+ run: 'cd ~/frappe-bench/ && bench --site test_site run-tests --app helpdesk --coverage'
  env:
  TYPE: server
  CI_BUILD_ID: ${{ github.run_id }}

.gitignore

@@ -30,7 +30,7 @@ share/python-wheels/
 *.egg
 MANIFEST
 
-frappedesk/docs/current
-frappedesk/public/desk
-frappedesk/public/node_modules
-frappedesk/www/frappedesk/index.html
+helpdesk/docs/current
+helpdesk/public/desk
+helpdesk/public/node_modules
+helpdesk/www/helpdesk/index.html

MANIFEST.in

@@ -4,15 +4,15 @@ include *.json
 include *.md
 include *.py
 include *.txt
-recursive-include frappedesk *.css
-recursive-include frappedesk *.csv
-recursive-include frappedesk *.html
-recursive-include frappedesk *.ico
-recursive-include frappedesk *.js
-recursive-include frappedesk *.json
-recursive-include frappedesk *.md
-recursive-include frappedesk *.png
-recursive-include frappedesk *.py
-recursive-include frappedesk *.svg
-recursive-include frappedesk *.txt
-recursive-exclude frappedesk *.pyc
+recursive-include helpdesk *.css
+recursive-include helpdesk *.csv
+recursive-include helpdesk *.html
+recursive-include helpdesk *.ico
+recursive-include helpdesk *.js
+recursive-include helpdesk *.json
+recursive-include helpdesk *.md
+recursive-include helpdesk *.png
+recursive-include helpdesk *.py
+recursive-include helpdesk *.svg
+recursive-include helpdesk *.txt
+recursive-exclude helpdesk *.pyc

README.md

@@ -1,14 +1,13 @@
 <div align="center" markdown="1">
-<img src="https://user-images.githubusercontent.com/46772424/181754239-a337beb3-fd35-4f27-969c-b9793f011458.svg" alt="FrappeDesk logo" width="170"/>
+<img src="https://user-images.githubusercontent.com/46772424/181754239-a337beb3-fd35-4f27-969c-b9793f011458.svg" alt="Frappe Helpdesk logo" width="170"/>
 
-**Open Source Helpdesk** </br>
+**Free and Open Source Helpdesk** </br>
 [frappedesk.com](https://frappedesk.com)
-
 </div>
 
 ---
 
-FrappeDesk 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,
+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,
 
 - Create tickets from email or help center
 - Empower customers with a comprehensive knowledge base and self-service portal
@@ -18,26 +17,36 @@ FrappeDesk offers an easy setup, clean user interface, and automation tools to r
 
 ## Installation
 
-### Local
+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
+
+ ```
+ bench get-app helpdesk
+ bench new-site helpdesk.test
+ bench --site helpdesk.test install-app helpdesk
+ bench --site helpdesk.test add-to-hosts
+ ```
+
+ You can now access Helpdesk at `http:https://helpdesk.test`
+5. You can also run a development server by following theses steps, in Helpdesk
+ directory (`apps/helpdesk`)
 
-To setup the repository locally follow the steps mentioned below:
+ ```
+ yarn
+ yarn dev
+ ```
 
-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 frappedesk.test`
-1. Map your site to localhost with the command `bench --site frappedesk.test add-to-hosts`
-1. Get the Frappe Desk app. Run `bench get-app https://github.com/frappe/desk`
-1. Run `bench --site frappedesk.test install-app frappedesk`.
-1. Now open the URL `http:https://frappedesk.test:8000/frappedesk` in your browser, you should see the app running
+ Development server will be now available at `http:https://localhost:8080`
 
 ## Contributions and Community
 
 There are many ways you can contribute even if you don't code:
 
 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. You can join our [telegram group](https://t.me/frappedesk) and share your thoughts.
+3. Join our [Telegram group](https://t.me/frappedesk) and share your thoughts.
 
 ## License
 
-[GNU Affero General Public License v3.0](https://github.com/frappe/desk/blob/main/licence.md)
+[GNU Affero General Public License v3.0](/licence.md)

desk/index.html

@@ -4,7 +4,7 @@
  <meta charset="UTF-8" />
  <link rel="icon" href="/favicon.svg" />
  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
- <title>Frappe Desk</title>
+ <title>Helpdesk</title>
  </head>
  <body>
  <div id="app"></div>

desk/package.json

@@ -5,9 +5,9 @@
  "scripts": {
  "dev": "vite",
  "preview": "vite preview",
- "build": "vite build --base=/assets/frappedesk/desk/ && yarn copy-html-entry",
+ "build": "vite build --base=/assets/helpdesk/desk/ && yarn copy-html-entry",
  "serve": "vite preview",
- "copy-html-entry": "cp ../frappedesk/public/desk/index.html ../frappedesk/www/frappedesk/index.html"
+ "copy-html-entry": "cp ../helpdesk/public/desk/index.html ../helpdesk/www/helpdesk/index.html"
  },
  "dependencies": {
  "@headlessui/vue": "^1.7.12",

desk/src/App.vue

@@ -48,10 +48,10 @@ export default {
  resources: {
  helpdeskName() {
  return {
- url: "frappedesk.api.website.helpdesk_name",
+ url: "helpdesk.api.website.helpdesk_name",
  auto: true,
  onSuccess: (res) => {
- document.title = `Frappe Desk ${res ? ` | ${res}` : ""}`;
+ document.title = `Helpdesk ${res ? ` | ${res}` : ""}`;
  },
  };
  },

desk/src/components/desk/SideBarMenu.vue

@@ -32,7 +32,7 @@
  <div
  v-for="option in menuOptions"
  :key="option.label"
- class="flex cursor-pointer items-center gap-2 rounded-lg p-2"
+ class="flex cursor-pointer items-center gap-2 rounded-lg px-2 py-1"
  :class="{
  'bg-gray-200': isActive(option.label),
  'text-gray-900': isActive(option.label),
@@ -51,7 +51,7 @@
  <div
  v-for="option in footerOptions"
  :key="option.label"
- class="flex cursor-pointer items-center gap-2 rounded-lg p-2"
+ class="flex cursor-pointer items-center gap-2 rounded-lg px-2 py-1"
  :class="{
  'bg-gray-200': isActive(option.label),
  'text-gray-900': isActive(option.label),
@@ -127,28 +127,28 @@ const menuOptions = [
  label: "Dashboard",
  icon: "dashboard",
  to: {
- path: "/frappedesk/dashboard",
+ path: "/helpdesk/dashboard",
  },
  },
  {
  label: "Tickets",
  icon: "ticket",
  to: {
- path: "/frappedesk/tickets",
+ path: "/helpdesk/tickets",
  },
  },
  {
  label: "Customers",
  icon: "customer",
  to: {
- path: "/frappedesk/customers",
+ path: "/helpdesk/customers",
  },
  },
  {
  label: "Contacts",
  icon: "customers",
  to: {
- path: "/frappedesk/contacts",
+ path: "/helpdesk/contacts",
  },
  },
 ];
@@ -158,14 +158,14 @@ const footerOptions = [
  label: "Knowledge Base",
  icon: "kb-articles",
  to: {
- path: "/frappedesk/kb",
+ path: "/helpdesk/kb",
  },
  },
  {
  label: "Settings",
  icon: "settings",
  to: {
- path: "/frappedesk/settings",
+ path: "/helpdesk/settings",
  },
  },
 ];
@@ -182,7 +182,7 @@ const profileSettings = [
  label: "Customer portal",
  icon: "users",
  handler: () => {
- window.open("/support/tickets", "_blank");
+ window.open("/helpdesk/my-tickets", "_blank");
  },
  },
  {
@@ -193,13 +193,13 @@ const profileSettings = [
 ];
 
 const routeMap = {
- "Knowledge Base": "frappedesk/kb",
- Contacts: "frappedesk/contacts",
- Customers: "frappedesk/customers",
- Dashboard: "frappedesk/dashboard",
- Reports: "frappedesk/reports",
- Settings: "frappedesk/settings",
- Tickets: "frappedesk/tickets",
+ "Knowledge Base": "helpdesk/kb",
+ Contacts: "helpdesk/contacts",
+ Customers: "helpdesk/customers",
+ Dashboard: "helpdesk/dashboard",
+ Reports: "helpdesk/reports",
+ Settings: "helpdesk/settings",
+ Tickets: "helpdesk/tickets",
 };
 
 function isActive(label: string) {

desk/src/components/desk/contacts/ContactInfo.vue

@@ -125,10 +125,10 @@
  }
  "
  :resourceOptions="{
- url: 'frappedesk.extends.client.get_list',
+ url: 'helpdesk.extends.client.get_list',
  inputMap: (query) => {
  return {
- doctype: 'FD Customer',
+ doctype: 'HD Customer',
  pluck: 'name',
  filters: [['name', 'like', `%${query}%`]],
  }
@@ -260,7 +260,7 @@ export default {
  const links = []
  if (values.customer) {
  links.push({
- link_doctype: "FD Customer",
+ link_doctype: "HD Customer",
  link_name: values.customer,
  })
  }

desk/src/components/desk/contacts/ContactRelatedInfo.vue

@@ -3,7 +3,7 @@
  <ListManager
  ref="miniTicketList"
  :options="{
- doctype: 'Ticket',
+ doctype: 'HD Ticket',
  fields: [
  '_assign',
  'status',
@@ -240,7 +240,7 @@ export default {
  resources: {
  bulkAssignTicketStatus() {
  return {
- url: "frappedesk.api.ticket.bulk_assign_ticket_status",
+ url: "helpdesk.api.ticket.bulk_assign_ticket_status",
  onSuccess: (res) => {
  this.$refs.miniTicketList.manager.selectedItems = []
  this.$refs.miniTicketList.manager.reload()
@@ -264,7 +264,7 @@ export default {
  },
  bulkAssignTicketToAgent() {
  return {
- url: "frappedesk.api.ticket.bulk_assign_ticket_to_agent",
+ url: "helpdesk.api.ticket.bulk_assign_ticket_to_agent",
  onSuccess: () => {
  this.$refs.miniTicketList.manager.selectedItems = []
  this.$refs.miniTicketList.manager.reload()

desk/src/components/desk/customers/CustomerInfo.vue

@@ -151,7 +151,7 @@
  >
  <div class="w-[30%]">
  <router-link
- :to="`/frappedesk/contacts/${contact.name}`"
+ :to="`/helpdesk/contacts/${contact.name}`"
  >
  {{ contact.first_name }}
  {{
@@ -207,10 +207,10 @@
  <ListManager
  ref="ticketList"
  :options="{
- cache: ['Ticket', 'Customer', customer],
+ cache: ['HD Ticket', 'Customer', customer],
  saveFiltersLocally: false,
  urlQueryFilters: false,
- doctype: 'Ticket',
+ doctype: 'HD Ticket',
  filters: {
  customer: ['=', customerDoc.customer_name],
  },
@@ -393,7 +393,7 @@ export default {
  customer() {
  return {
  type: "document",
- doctype: "FD Customer",
+ doctype: "HD Customer",
  name: this.customer,
  setValue: {
  onSuccess() {
@@ -411,14 +411,14 @@ export default {
  url: "frappe.client.rename_doc",
  onSuccess: (res) => {
  this.$router.push({
- path: `/frappedesk/customers/${res}`,
+ path: `/helpdesk/customers/${res}`,
  })
  },
  }
  },
  contact() {
  return {
- url: "frappedesk.api.fdCustomer.get_contact",
+ url: "helpdesk.api.fdCustomer.get_contact",
  params: {
  doctype: "Contact",
  link_name: this.customer,
@@ -460,7 +460,7 @@ export default {
  })
  if (this.values.customerName !== this.customer) {
  this.$resources.renameCustomerDoc.submit({
- doctype: "FD Customer",
+ doctype: "HD Customer",
  old_name: this.customer,
  new_name: this.values.customerName,
  })

desk/src/components/desk/dashboard/CustomerSatisfactionChart.vue

@@ -70,7 +70,7 @@ export default {
  resources: {
  getFeedbackStatusCount() {
  return {
- url: "frappedesk.api.dashboard.feedback_status",
+ url: "helpdesk.api.dashboard.feedback_status",
  params: {
  dateFilter: [
  "creation",

desk/src/components/desk/dashboard/SlaSummaryCards.vue

@@ -55,19 +55,19 @@ export default {
  resources: {
  averageFirstResponseTime() {
  return {
- url: "frappedesk.api.dashboard.average_first_response_time",
+ url: "helpdesk.api.dashboard.average_first_response_time",
  auto: true,
  }
  },
  averageResolutionTime() {
  return {
- url: "frappedesk.api.dashboard.average_resolution_time",
+ url: "helpdesk.api.dashboard.average_resolution_time",
  auto: true,
  }
  },
  resolutionWithinSla() {
  return {
- url: "frappedesk.api.dashboard.resolution_within_sla",
+ url: "helpdesk.api.dashboard.resolution_within_sla",
  auto: true,
  }
  },

desk/src/components/desk/dashboard/TicketStatusCards.vue

@@ -108,7 +108,7 @@ export default {
  resources: {
  getTicketStatusCount() {
  return {
- url: "frappedesk.api.dashboard.ticket_status",
+ url: "helpdesk.api.dashboard.ticket_status",
  auto: true,
  }
  },