You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+37-30Lines changed: 37 additions & 30 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,5 +1,5 @@
1
1
# Panic Help Desk
2
-
This is a ticketing system for [Laravel](https://laravel.com/) PHP framework (from version 5 to 8): It is based on [Kordy/Ticketit](https://github.com/thekordy/ticketit). We have kept almost [all ticketit features](https://github.com/thekordy/ticketit/wiki/v0.2-Features) and added many additional functionalities, like file attachments, ticket tags, scheduling, filtering and an advanced search form. This package uses an own route, "/PanicHD" which can be customized, so It may be installed in your existent Laravel project.
2
+
This is a ticketing system for [Laravel](https://laravel.com/) PHP framework (from version 5 to 8): It is based on [Kordy/Ticketit](https://github.com/thekordy/ticketit). We have kept almost [all ticketit features](https://github.com/thekordy/ticketit/wiki/v0.2-Features) and added many additional functionalities, like file attachments, ticket tags, scheduling, filtering and an advanced search form. This package uses an own route, "/PanicHD" which can be modified after installation, so it may be installed in your existent Laravel project.
3
3
4
4
## Table of contents
5
5
@@ -10,12 +10,15 @@ This is a ticketing system for [Laravel](https://laravel.com/) PHP framework (fr
10
10
+[Feature synopsis](#features)
11
11
+[Features in detail (link to the Wiki)](https://github.com/panichelpdesk/panichd/wiki/Current-features)
12
12
*[Installing](#installing)
13
-
+[Requirements](#requirements)
14
-
+[If Kordy/Ticketit is installed](#if-kordyticketit-is-installed)
15
-
+[Installation steps](#installation-steps)
16
-
+[Complete installation](#complete-installation)
17
-
+[With the web installer](#option-1-web-installer)
*[Configurations and Laravel integration](#configurations-and-laravel-integration)
20
23
*[Contributing](#contributing)
21
24
*[Built with](#built-with)
@@ -32,9 +35,11 @@ This ticketing system is actually mean to be used in a corporate support environ
32
35
* We have included all required asset files in the package structure because we want it to be usable in our LAN even without working internet connection (think about IT corporate support)
33
36
34
37
#### Translations
35
-
This package comes with Catalan, English and Brazillian Portuguese language files. For any of them you don't need to do anything: PanicHD will get your Laravel configuration.
38
+
This package has got up to date translations to Brazillian Portuguese, Catalan, English and Spanish. There are more translations included, but they're oldier and some menues may not be translated yet.
36
39
37
-
You may also you may create your own language files. There are some outdated language files that come from Ticketit and can be a good starting point. We encourage you to make your own language files and create a pull request in PanicHD to share with other speakers.
40
+
PanicHD used language will be the one you have configured within Laravel.
41
+
42
+
You may also create your own language files. We encourage you to make your own language pack and add a pull request to our **dev** branch, to let other PanicHD members from your country have it.
38
43
39
44
#### A ticket step by step example
40
45
1. A user registers a new ticket for a specific issue
@@ -95,15 +100,15 @@ This is a synopsis of the main PanicHD features. For detailed descriptions, exam
95
100
`php artisan panichd`
96
101
97
102
## Installing
98
-
### Requirements
103
+
### 1- Requirements
99
104
*[Laravel](https://laravel.com/) 5.1 or higher including:
100
105
+[Laravel auth](https://laravel.com/docs/master/authentication#authentication-quickstart) with at least one user registered
101
106
+ Model App\User.php that uses users table. It is added with Laravel auth by default and PanicHD requires it to be there. It seems that some admin panels change it to App\Models\User.php or maybe other routes.
102
107
+ Valid email configuration (Needed for PanicHD notification emails)
103
108
104
109
*[Composer](https://getcomposer.org/) (the PHP dependency manager)
105
110
106
-
### If Kordy/Ticketit is installed
111
+
### 2- If Kordy/Ticketit is installed
107
112
If it's installed in the same Laravel project you want to install Panic Help Desk, Panic Help Desk will replace it, reusing it's database tables and keeping registered tickets. Before installing PanicHD, you will have to uninstall Kordy/Ticketit following these steps:
108
113
109
114
1. Open composer.json file at laravel root folder. Remove the line that reffers to kordy/ticketit in the "require" section
@@ -112,31 +117,31 @@ If it's installed in the same Laravel project you want to install Panic Help Des
112
117
`composer update kordy/ticketit`
113
118
4. Delete all possible remaining refferences and files that you may have in your Laravel project (Published files? Refferences in Laravel files?)
114
119
115
-
### Installation steps
120
+
### 3- Add and enable PanicHD package
116
121
1. Open a command line in the Laravel folder and type:
117
122
`composer require panichd/panichd`
118
123
2. If you are using Laravel 5.4 or lower, you will have to add the service provider. In this case, Open config/app.php. In the "Providers" section, add:
119
124
120
125
`PanicHD\PanicHD\PanicHDServiceProvider::class,`
121
126
122
-
### Complete installation
123
-
At this point, if you think you typed enough commands, the [web installer](#option-1-web-installer) comes to rescue you ;) But if you're a tough and experienced Laravel coder, please forget this and jump to [Complete installation with command line](#option-2-command-line-for-advanced-users) section.
127
+
### 4- Configure it
128
+
At this point, if you think you typed enough commands, the [web installer](#option-1-web-installer) comes to rescue you ;) But if you're a tough and experienced Laravel coder, please forget this and jump to [Complete installation with command line](#option-b-using-command-line-advanced-users) section.
124
129
125
-
#### Option 1: Web installer
130
+
#### **Option A: With our web installer**
126
131
To access the web installer you just have to:
127
132
128
133
1. Log in the Laravel app via web browser
129
134
2. access URL http://your-laravel-app-URL/panichd
130
135
3. Read and follow the installation steps
131
136
132
-
#### Option 2: Command line (for advanced users)
133
-
Create the attachments folders:
137
+
#### **Option B: Using command line (advanced users)**
138
+
**B.1-**Create the attachments folders:
134
139
1. Access "storage" folder inside Laravel root and create the subfolder:
135
140
`panichd_attachments`
136
141
2. Access storage\app\public and create the subfolder:
137
142
`panichd_thumbnails`
138
143
139
-
Execute these commands:
144
+
**B.2-**Execute these commands:
140
145
1. Publish and install migrations
141
146
142
147
1.1 Publish migrations:
@@ -160,22 +165,24 @@ Execute these commands:
160
165
161
166
`php artisan vendor:publish --tag=panichd-public`
162
167
163
-
6. If you didn't have Kordy/Ticketit, you will have to enable your user account (or any other) as an admin in Panic Help Desk. In the "users" table, just find your account and set "panichd_admin" value to 1.
168
+
**B.3-** If your have done a clean PanicHD installation, you must enable at least one administrator for it by setting users table row/s "panichd_admin" field value to 1.
169
+
170
+
**B.4-** Access http://your-laravel-app-URL/panichd in your browser
171
+
172
+
### 5- App start-up
173
+
#### **Add demostration data**
174
+
You may use [our demo data seeder](https://github.com/panichelpdesk/panichd/wiki/Command-line-toolbox#demodataseeder) to test the package quickly. The following command creates some fake users, tickets and other stuff which you may browse, edit and do whatever you want:
164
175
165
-
7. Test functionality with generated demo content
166
-
If you want to test the package first, you can install some demo contents from command line in your Laravel app:
- To delete the contents addded by the demo, read the [panichd:demo-rollback command dedicated wiki section](https://github.com/panichelpdesk/panichd/wiki/Command-line-toolbox#panichddemo-rollback).
171
-
178
+
To [delete all PanicHD demo content](https://github.com/panichelpdesk/panichd/wiki/Command-line-toolbox#panichddemo-rollback) use this command:
172
179
173
-
8. Configure the package for real environment usage
174
-
- If you want to add the included default priorities, statuses and category:
- If you want to create only your custom parameters, you can skip to the next installation step
180
+
`php artisan panichd:demo-rollback`
181
+
182
+
#### **Add our basic parameters set**
183
+
Before you can create tickets, you must have added at least one Priority, one Status and one Category. You may use our basic seeder to fill these lists with default elements meant for general usage. All added items will be editable. To use it type the following command:
177
184
178
-
9. Access http://your-laravel-app-URL/panichd in your browser
*[Photoswipe](http://photoswipe.com/): The best free javascript image gallery we found outside there
209
216
*[Bootstrap Colorpicker Plus](https://github.com/zzzhan/bootstrap-colorpicker-plus): The javascript color picker for every customizable color in PanicHD
210
217
*[Bootstrap Datetimepicker](http://eonasdan.github.io/bootstrap-datetimepicker/): A great javascript calendar selector
0 commit comments