Skip to content

Commit

Permalink
Merge pull request #7 from abdumu/master
Browse files Browse the repository at this point in the history
add docs
  • Loading branch information
abdumu authored Feb 3, 2021
2 parents 9f632bf + 2827ad6 commit b0e7d87
Show file tree
Hide file tree
Showing 4 changed files with 64 additions and 0 deletions.
13 changes: 13 additions & 0 deletions docs/1_introduction.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
prev: ./
next: 2_installation
---

# Introduction
It's a tool to help ease the repetitive migration process during developing a Laravel project without migrate:fresh your database every time you change you schemas.


## Features
- Easy to install, no need to add or change your schemas or project files.
- Sync schema changes to database instantly. No need to repeat fresh or seed commands everytime.
- Interactive. It will give you choices to not force unwanted changes to your database.
14 changes: 14 additions & 0 deletions docs/2_installation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
prev: 1_introduction
next: 2_quick-start
---

# Installation

To get started, use Composer to add the package to your project's dependencies:
```bash
composer require awssat/laravel-sync-migration
```

#### Before Laravel 5.5
In Laravel 5.4. you'll manually need to register the `Awssat\SyncMigration\SyncMigrationServiceProvider::class` service provider in `config/app.php`.
18 changes: 18 additions & 0 deletions docs/2_quick-start.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
---
prev: 2_installation
next: false
---


# Quick Start

## Start using it
It's simple. Anytime you want sync schema files to database run this command:
```sh
php artisan migrate:sync
```

## how to use (gif image)
<p align="center">
<img src="https://thumbs.gfycat.com/SplendidFlatAustrianpinscher-size_restricted.gif" alt="Laravel Sync Migration">
</p>
19 changes: 19 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
---
prev: false
next: 1_introduction
---

# Laravel Sync Migration

<p align="center">
<img src="https://i.imgur.com/OP83jHA.jpg" alt="Laravel Sync Migration" style="width:400px">
</p>


### Contributing

Please see [the package github repo](https://github.com/awssat/laravel-sync-migration) for details.

### License

The MIT License (MIT).

0 comments on commit b0e7d87

Please sign in to comment.