Skip to content
This repository was archived by the owner on Apr 1, 2021. It is now read-only.

Commit f24bc8a

Browse files
committed
improve README docs
1 parent 9de8f21 commit f24bc8a

File tree

1 file changed

+32
-0
lines changed

1 file changed

+32
-0
lines changed

README.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,15 @@
55
[![GitHub version](https://badge.fury.io/gh/adenvt%2Flaravel-coreui-vue.svg)](https://badge.fury.io/gh/adenvt%2Flaravel-coreui-vue)
66
[![Greenkeeper badge](https://badges.greenkeeper.io/adenvt/laravel-coreui-vue.svg)](https://greenkeeper.io/)
77

8+
## What's inside
9+
* [Laravel][laravel] 5.6, A PHP framework for web artisans
10+
* [Core UI][coreui] for Vue, Free Bootstrap Admin Template
11+
* Usefull library: [Axios][axios], [jQuery][jquery], [Moment.js][moment], [Lodash][lodash]
12+
* [Vue Router][vue-router] and [Vuex][vuex], set out of the box
13+
* Notification using [Vue-SweatAlert2][vue-sweatalert2] and [Vue-Notification][vue-notification]
14+
* Loading spinner with [Vue Loading Spinner][vue-loading-spinner]
15+
* Quick deployment with [Docker Compose][docker-compose] [TODO]
16+
817
## Requirement
918
* **PHP** >= 7.1.3
1019
* OpenSSL PHP Extension
@@ -39,8 +48,31 @@ php artisan key:generate
3948
```bash
4049
chmod -R go+w storage bootstrap/cache
4150
```
51+
* Compile Static Asset
52+
```bash
53+
## for Development
54+
npm run dev
55+
56+
## for Production
57+
npm run prod
58+
59+
### for Development with HMR (Hot Module Replacement)
60+
npm run hot
61+
```
4262

4363
## License
4464
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details
4565

4666
[download]: https://github.com/adenvt/laravel-coreui-vue/archive/0.1.0.zip
67+
[laravel]: https://laravel.com
68+
[coreui]: https://coreui.io
69+
[axios]: https://github.com/axios/axios
70+
[jquery]: https://jquery.com/
71+
[lodash]: https://lodash.com/
72+
[moment]: https://momentjs.com/
73+
[vue-router]: https://router.vuejs.org/
74+
[vuex]: https://vuex.vuejs.org/
75+
[vue-sweatalert2]: https://github.com/avil13/vue-sweetalert2
76+
[vue-notification]: http://vue-notification.yev.io/
77+
[vue-loading-spinner]: https://nguyenvanduocit.github.io/vue-loading-spinner/
78+
[docker-compose]: https://docs.docker.com/compose/

0 commit comments

Comments
 (0)