Skip to content

Commit 8efe8a2

Browse files
committed
Merge branch 'master' of github.com:darryldecode/laravelbackend
2 parents 240d6df + 885c852 commit 8efe8a2

File tree

1 file changed

+90
-5
lines changed

1 file changed

+90
-5
lines changed

README.md

Lines changed: 90 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,12 +8,97 @@ Laravel Backend is an instant backend for laravel 5. It is a component base arch
88
- Navigation Builder
99
- Media Manager
1010

11-
### NOTE:
11+
### INSTALLATION
12+
---
13+
**--NOTE IMPORTANT--**
14+
15+
- make sure to set all your database connection first.
16+
- make sure to set correct "url" on config/app.php
17+
18+
---
19+
20+
***Step 1:*** On your composer.json, add this on require block:
21+
```
22+
"require": {
23+
"darryldecode/laravelbackend": "dev-master"
24+
}
25+
```
26+
then you can do: ```composer update "darryldecode/laravelbackend"``` to update/install the package
27+
28+
---
29+
***Step 2:***
30+
- add this lines in config/app.php on providers array:
31+
```
32+
Darryldecode\Backend\BackendServiceProvider::class,
33+
Darryldecode\Backend\BackendRoutesServiceProvider::class,
34+
```
1235

13-
> You can even build your own components easily to fit your application needs! It's very easy!
36+
- add this lines in config/app.php on aliases array:
37+
```
38+
'Form' => Illuminate\Html\FormFacade::class,
39+
'Html' => Illuminate\Html\HtmlFacade::class,
40+
```
41+
---
42+
***Step 3:***
43+
> **NOTE:** Delete all default migration first bundled with your laravel installation. Backend package has its own full-blown user component. After you have deleted it, do this on your command line:
1444
15-
### Installation
45+
```
46+
php artisan vendor:publish --provider="Darryldecode\Backend\BackendServiceProvider"
47+
```
1648

17-
```sh
18-
Comming Soon!
49+
Then do:
50+
```
51+
composer dump-autoload
52+
```
53+
---
54+
55+
***Step 5:***
56+
57+
On your terminal, do:
58+
```
59+
php artisan migrate
60+
php artisan db:seed --class=BackendSeeder
1961
```
62+
---
63+
***Step 6:***
64+
- on config/auth.php
65+
```
66+
changed your model to: 'Darryldecode\Backend\Components\User\Models\User'
67+
```
68+
- on config/filesystems.php
69+
```
70+
changed the local disks:
71+
'root' => storage_path('app'),
72+
to:
73+
'root' => public_path('uploads'),
74+
```
75+
76+
---
77+
78+
***CONRGATULATIONS!*** Your instant laravel 5 backend is ready! you can login by navigating to: ```/backend/login```
79+
80+
- user: admin@gmail.com
81+
- pass: admin
82+
83+
Please change your credentials. You can change your backend url on config.
84+
85+
---
86+
87+
***TESTS:***
88+
89+
You can run the tests to make sure all functionality is good.
90+
first: open your ```phpunit.xml``` config and add this to your test suites:
91+
92+
<testsuite name="Backend">
93+
<directory>./vendor/darryldecode/backend/tests/</directory>
94+
</testsuite>
95+
96+
then run: ```"phpunit --testsuite Backend"``` on your command line of choice.
97+
98+
-------------------------------------------------------------
99+
100+
Next? Read the full documentation to get the most of the package! Extending is easy aswell! Enjoy!
101+
102+
### NOTE:
103+
104+
> PACKAGE IS STILL IN ALPHA AND STILL IN ACTIVE DEVELOPMENT! **Documenation coming soon!**

0 commit comments

Comments
 (0)