diff --git a/docs/.vuepress/config.js b/docs/.vuepress/config.js new file mode 100644 index 0000000..ae9281f --- /dev/null +++ b/docs/.vuepress/config.js @@ -0,0 +1,38 @@ +module.exports = { + sidebar: true, + base: "/laravel-packer/", + title: "Laravel Packer", + sidebar: true, + themeConfig: { + repo: "bitfumes/laravel-packer", + sidebar: [ + { + title: "Get Started", + collapsable: false, + path: "/installation" + }, + { + title: "Artisan Commands", + path: "/artisan", + collapsable: true + }, + { + title: "Crud Generator", + path: "/crud", + collapsable: true + }, + { + title: "Smart Clone", + path: "/clone", + collapsable: true + }, + "/support" + ], + repoLabel: "Github", + docsDir: "docs", + docsBranch: "master", + editLinks: true, + editLinkText: "Help us improve this page!", + smoothScroll: true + } +}; diff --git a/docs/artisan.md b/docs/artisan.md new file mode 100644 index 0000000..682aa2b --- /dev/null +++ b/docs/artisan.md @@ -0,0 +1 @@ +# Artisan Commands while creating package diff --git a/docs/clone.md b/docs/clone.md new file mode 100644 index 0000000..90af12b --- /dev/null +++ b/docs/clone.md @@ -0,0 +1 @@ +# Smart Clone diff --git a/docs/crud.md b/docs/crud.md new file mode 100644 index 0000000..2484c74 --- /dev/null +++ b/docs/crud.md @@ -0,0 +1 @@ +# CRUD Generator diff --git a/docs/installation.md b/docs/installation.md new file mode 100644 index 0000000..0e89e0c --- /dev/null +++ b/docs/installation.md @@ -0,0 +1,10 @@ +# Installation + +Install via composer. +::: tip Node: +For windows user, first run `composer global update` +::: + +```bash{1} +composer global require bitfumes/laravel-packer +``` diff --git a/docs/readme.md b/docs/readme.md new file mode 100644 index 0000000..30dd399 --- /dev/null +++ b/docs/readme.md @@ -0,0 +1,28 @@ +--- +home: true +heroText: Laravel Packer +description: A Command Line Tool which is going to help you in creating package and making CRUD with tests in laravel. +actionText: Get Started +actionLink: /installation +sidebar: true +features: + - title: Artisan Command for Package + details: You can use all artisan commands while creating laravel package. + - title: CRUD Generator + details: Packr is usefull to create CRUD for any model with tests in laravel. + - title: Smart Clone + details: Reduce 4 steps to clone laravel repo into 1 by using smart clone. + footer: MIT Licensed | Copyright © 2020 Bitfumes +--- + +# Quick start + +Note: For windows user, first run `composer global update` + +```bash{2,5} +# First, install: +composer global require bitfumes/laravel-packer + +# Then, use it just like you use artisan commands: +packr make:model Student -mfc +``` diff --git a/docs/support.md b/docs/support.md new file mode 100644 index 0000000..fd2e3a3 --- /dev/null +++ b/docs/support.md @@ -0,0 +1,9 @@ +# Support the development + +Do you like this package? Support it by donating: + +- Patreon: [Donate](https://www.patreon.com/bitfumes) +- PayPal: [Donate](https://paypal.me/bitfumes) +- OpenCollective: [Donate](https://opencollective.com/bitfumes) + +Laravel Packer is open-sourced software licensed under the [MIT license](https://github.com/bitfumes/laravel-packer/blob/master/LICENSE.md).