Skip to content

Commit 6738315

Browse files
committed
Update Readme.
1 parent 60fd14f commit 6738315

File tree

1 file changed

+48
-45
lines changed

1 file changed

+48
-45
lines changed

README.md

Lines changed: 48 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -119,51 +119,6 @@ Add the BlogServiceProvider to `/config/app.php`
119119
Modules\Blog\BlogServiceProvider::class,
120120
```
121121

122-
### Blog Seeders (Optional Step)
123-
124-
The Blog Module has two built in Seeders:
125-
126-
1 - **BlogSeeder**: Will create `posts`, `authors`, `categories` and `tags`.
127-
128-
2 - **BlogAclSeeder**: Will create the ACL Permissions associated with the module, so it can be associated with the desired `ACL Role` through the App Interface.
129-
130-
You can manually run the seeders or you can add the seeders to be executed in the `database/seeders/DatabaseSeeder.php` file.
131-
132-
#### Adding the seeders to the DatabaseSeeder file
133-
134-
To add the seeders to the main DatabaseSeeder file, import the BlogSeeders and call them inside the `run` method:
135-
136-
```php
137-
<?php
138-
139-
namespace Database\Seeders;
140-
141-
use Illuminate\Database\Seeder;
142-
use Modules\Blog\Database\Seeders\BlogAclSeeder;
143-
use Modules\Blog\Database\Seeders\BlogSeeder;
144-
145-
public function run(): void
146-
{
147-
$this->call(BlogAclSeeder::class);
148-
$this->call(BlogSeeder::class);
149-
}
150-
151-
```
152-
153-
#### Manually executing the Seeders
154-
155-
To manually execute the Seeders you can run:
156-
157-
```bash
158-
php artisan db:seed --class="Modules\\Blog\\Database\\Seeders\\BlogSeeder"
159-
```
160-
161-
And also:
162-
163-
```bash
164-
php artisan db:seed --class="Modules\\Blog\\Database\\Seeders\\BlogAclSeeder"
165-
```
166-
167122
### 2 - Backend Menu Items
168123

169124
Add the menu items to the `resources/js/Configs/menu.js` items array:
@@ -227,6 +182,54 @@ plugins: [
227182
],
228183
```
229184

185+
That's it, the Blog Module should be all functional in this step.
186+
187+
### Blog Seeders (Optional Step)
188+
189+
The Blog Module has two built in Seeders:
190+
191+
1 - **BlogSeeder**: Will create `posts`, `authors`, `categories` and `tags`. It will fetch images online to populate `posts`, `authors` and `categories`, so it can take a few seconds to complete.
192+
193+
2 - **BlogAclSeeder**: Will create the ACL Permissions associated with the module, so it can be associated with the desired `ACL Role` through the App Interface.
194+
195+
You can manually run the seeders or you can add the seeders to be executed in the `database/seeders/DatabaseSeeder.php` file.
196+
197+
#### Adding the seeders to the DatabaseSeeder file
198+
199+
To add the seeders to the main DatabaseSeeder file, import the BlogSeeders and call them inside the `run` method:
200+
201+
```php
202+
<?php
203+
204+
namespace Database\Seeders;
205+
206+
use Illuminate\Database\Seeder;
207+
use Modules\Blog\Database\Seeders\BlogAclSeeder;
208+
use Modules\Blog\Database\Seeders\BlogSeeder;
209+
210+
public function run(): void
211+
{
212+
$this->call(BlogAclSeeder::class);
213+
$this->call(BlogSeeder::class);
214+
}
215+
216+
```
217+
218+
#### Manually executing the Seeders
219+
220+
To manually execute the Seeders you can run:
221+
222+
```bash
223+
php artisan db:seed --class="Modules\\Blog\\Database\\Seeders\\BlogSeeder"
224+
```
225+
226+
And also:
227+
228+
```bash
229+
php artisan db:seed --class="Modules\\Blog\\Database\\Seeders\\BlogAclSeeder"
230+
```
231+
232+
230233
## License
231234

232235
The Modular Project is open-source software licensed under the [MIT license](LICENSE.md).

0 commit comments

Comments
 (0)