@@ -44,7 +44,12 @@ $ php artisan prequel:install
44
44
###### When installation and publishing is done navigate to ` /prequel ` in your browser to see Prequel in action!
45
45
46
46
## Updating
47
- ###### To update you can use the command specified below.
47
+ ``` bash
48
+ composer require protoqol/prequel:v1.2
49
+ ```
50
+
51
+ #### When using Prequel 1.2 and up you can try and use the auto updater!
52
+ #####And else to update you can use the command specified below.
48
53
``` bash
49
54
$ php artisan prequel:update
50
55
```
@@ -56,76 +61,135 @@ You might have noticed that, while publishing a config file appeared under `conf
56
61
That configuration file looks something like this.
57
62
> Note that you can define ` PREQUEL_ENABLED ` in your .env file.
58
63
``` php
59
- [
60
-
61
- /*
62
- |--------------------------------------------------------------------------
63
- | Prequel Master Switch : boolean
64
- |--------------------------------------------------------------------------
65
- |
66
- | Manually disable/enable Prequel, if in production Prequel will always
67
- | be disabled. Reason being that nobody should ever be able to directly look
68
- | inside your database besides you or your dev team (obviously).
69
- |
70
- */
71
- 'enabled' => env('PREQUEL_ENABLED', true),
72
-
73
- /*
74
- |--------------------------------------------------------------------------
75
- | Prequel Path : string
76
- |--------------------------------------------------------------------------
77
- |
78
- | The path where Prequel will be residing. Note that this does not affect
79
- | Prequel API routes.
80
- |
81
- */
82
- 'path' => 'prequel',
83
-
84
- /*
85
- |--------------------------------------------------------------------------
86
- | Prequel Database Configuration : array
87
- |--------------------------------------------------------------------------
88
- |
89
- | This enables you to fully configure your database-connection for Prequel.
90
- |
91
- */
92
- 'database' => [
93
- 'connection' => env('DB_CONNECTION', 'mysql'),
94
- 'host' => env('DB_HOST', '127.0.0.1'),
95
- 'port' => env('DB_PORT', '3306'),
96
- 'database' => env('DB_DATABASE', 'homestead'),
97
- 'username' => env('DB_USERNAME', 'homestead'),
98
- 'password' => env('DB_PASSWORD', 'secret'),
99
- ],
100
-
101
- /*
102
- |--------------------------------------------------------------------------
103
- | Prequel ignored databases and tables : array
104
- |--------------------------------------------------------------------------
105
- | Databases and tables that will be ignored during database discovery.
106
- |
107
- | Using 'mysql' => ['*'] ignores the entire mysql database.
108
- | Using 'mysql' => ['foo'] ignores only the mysql.foo table.
109
- */
110
- 'ignored' => [
111
- // 'information_schema' => ['*'],
112
- // 'sys' => ['*'],
113
- // 'performance_schema' => ['*'],
114
- // 'mysql' => ['*'],
115
- '#mysql50#lost+found' => ['*'],
116
- ],
117
-
118
- /*
119
- |--------------------------------------------------------------------------
120
- | Prequel pagination per page : integer
121
- |--------------------------------------------------------------------------
122
- |
123
- | When Prequel retrieves paginated information, this is the number of
124
- | records that will be in each page.
125
- |
126
- */
127
- 'pagination' => 100,
64
+ <?php
128
65
66
+ [
67
+
68
+ /*
69
+ |--------------------------------------------------------------------------
70
+ | Prequel Master Switch : boolean
71
+ |--------------------------------------------------------------------------
72
+ |
73
+ | Manually disable/enable Prequel, if in production Prequel will always be
74
+ | disabled. Reason being that nobody should ever be able to directly look
75
+ | inside your database besides you or your dev team (obviously).
76
+ |
77
+ */
78
+
79
+ 'enabled' => env('PREQUEL_ENABLED', true),
80
+
81
+
82
+ /*
83
+ |--------------------------------------------------------------------------
84
+ | Prequel Locale : string
85
+ |--------------------------------------------------------------------------
86
+ |
87
+ | Choose what language Prequel should display in.
88
+ |
89
+ */
90
+
91
+ 'locale' => env('APP_LOCALE', 'en'),
92
+
93
+
94
+ /*
95
+ |--------------------------------------------------------------------------
96
+ | Prequel Path
97
+ |--------------------------------------------------------------------------
98
+ |
99
+ | The path where Prequel will be residing. Note that this does not affect
100
+ | Prequel API routes.
101
+ |
102
+ */
103
+
104
+ 'path' => 'prequel',
105
+
106
+
107
+ /*
108
+ |--------------------------------------------------------------------------
109
+ | Laravel asset generation suffix and namespace definition
110
+ |--------------------------------------------------------------------------
111
+ |
112
+ | Here you can define your preferred asset suffixes and directory/namespaces.
113
+ | Separate with a double backwards slash to define namespace and directory
114
+ | location. Everything after the last '\\' will be treated as a suffix.
115
+ | Note that the backslash needs to be escaped with an extra backslash
116
+ |
117
+ | For example
118
+ |
119
+ | Configuration
120
+ | 'suffixes' => [
121
+ | 'model' => 'Models\\Model',
122
+ | 'seeder' => 'MyMadeUpSeederSuffix'
123
+ | ]
124
+ |
125
+ | When generating for `users` table
126
+ | (directory) app/models/UserModel.php
127
+ | (qualified class) App\Models\UserModel
128
+ | (directory) database/seeds/UserMyMadeUpSeederSuffix.php
129
+ |
130
+ */
131
+
132
+ 'suffixes' => [
133
+ 'model' => 'Models\\',
134
+ 'seeder' => 'Seeder',
135
+ 'factory' => 'Factory',
136
+ 'controller' => 'Controller',
137
+ 'resource' => 'Resource',
138
+ ],
139
+
140
+
141
+ /*
142
+ |--------------------------------------------------------------------------
143
+ | Prequel Database Configuration : array
144
+ |--------------------------------------------------------------------------
145
+ |
146
+ | This enables you to fully configure your database connection for Prequel.
147
+ |
148
+ */
149
+
150
+ 'database' => [
151
+ 'connection' => env('DB_CONNECTION', 'mysql'),
152
+ 'host' => env('DB_HOST', '127.0.0.1'),
153
+ 'port' => env('DB_PORT', '3306'),
154
+ 'database' => env('DB_DATABASE', 'homestead'),
155
+ 'username' => env('DB_USERNAME', 'homestead'),
156
+ 'password' => env('DB_PASSWORD', 'secret'),
157
+ ],
158
+
159
+
160
+ /*
161
+ |--------------------------------------------------------------------------
162
+ | Prequel ignored databases and tables : array
163
+ |--------------------------------------------------------------------------
164
+ | Databases and tables that will be ignored during database discovery.
165
+ |
166
+ | Using 'mysql' => ['foo'] ignores only the mysql.foo table.
167
+ | Using 'mysql' => ['*'] ignores the entire mysql database.
168
+ |
169
+ */
170
+
171
+ 'ignored' => [
172
+ // 'information_schema' => ['*'],
173
+ // 'sys' => ['*'],
174
+ // 'performance_schema' => ['*'],
175
+ // 'mysql' => ['*'],
176
+ '#mysql50#lost+found' => ['*'],
177
+ ],
178
+
179
+
180
+ /*
181
+ |--------------------------------------------------------------------------
182
+ | Prequel pagination per page : integer
183
+ |--------------------------------------------------------------------------
184
+ |
185
+ | When Prequel retrieves paginated information, this is the number of
186
+ | records that will be in each page.
187
+ |
188
+ */
189
+
190
+ 'pagination' => 100,
191
+
192
+
129
193
/*
130
194
|--------------------------------------------------------------------------
131
195
| Prequel middleware : array
@@ -136,11 +200,12 @@ That configuration file looks something like this.
136
200
| Ex. 'web', Protoqol\Prequel\Http\Middleware\Authorised::class
137
201
|
138
202
*/
139
-
203
+
140
204
'middleware' => [
141
205
Protoqol\Prequel\Http\Middleware\Authorised::class,
142
206
],
143
- ];
207
+ ];
208
+
144
209
```
145
210
146
211
![ Prequel Screenshot] ( ./assets/prequel_screenshot.png )
0 commit comments