Skip to content

Commit

Permalink
starting docs
Browse files Browse the repository at this point in the history
  • Loading branch information
sarthaksavvy committed Jan 29, 2020
1 parent 5d89c90 commit 8c83ec4
Show file tree
Hide file tree
Showing 7 changed files with 88 additions and 0 deletions.
38 changes: 38 additions & 0 deletions docs/.vuepress/config.js
Original file line number Diff line number Diff line change
@@ -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
}
};
1 change: 1 addition & 0 deletions docs/artisan.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Artisan Commands while creating package
1 change: 1 addition & 0 deletions docs/clone.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Smart Clone
1 change: 1 addition & 0 deletions docs/crud.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# CRUD Generator
10 changes: 10 additions & 0 deletions docs/installation.md
Original file line number Diff line number Diff line change
@@ -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
```
28 changes: 28 additions & 0 deletions docs/readme.md
Original file line number Diff line number Diff line change
@@ -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
```
9 changes: 9 additions & 0 deletions docs/support.md
Original file line number Diff line number Diff line change
@@ -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).

0 comments on commit 8c83ec4

Please sign in to comment.