https://github.com/schickling/laravel-schema-summary
Creates a summary file of all migrations
https://github.com/schickling/laravel-schema-summary
Last synced: 5 months ago
JSON representation
Creates a summary file of all migrations
- Host: GitHub
- URL: https://github.com/schickling/laravel-schema-summary
- Owner: schickling
- License: mit
- Created: 2014-05-14T19:47:43.000Z (about 12 years ago)
- Default Branch: master
- Last Pushed: 2014-05-15T08:39:17.000Z (about 12 years ago)
- Last Synced: 2025-03-29T08:12:49.223Z (over 1 year ago)
- Size: 137 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
laravel-schema-summary
======================
Creates a summary file of all migrations. This package is inspired by the `schema.rb` file of [Active Record Migrations](http://guides.rubyonrails.org/migrations.html).
## Installation
1. Add the following to your composer.json and run `composer update`
```json
{
"require": {
"schickling/laravel-schema-summary": "dev-master"
}
}
```
2. Add `Schickling\SchemaSummary\SchemaSummaryServiceProvider` to your config/app.php
## Usage
The following command creates a `Schema.md` file in your `app/database` directory which contains a summary of all migrations. This summary can be understood as **one big migration** for documentation purposes.
```sh
$ php artisan migrate:schema
```
## Example Output
### users
Field | Type | Length | Unsigned | Default
--- | --- | --- | --- | ---
id | INT | 10 | yes |
name | VARCHAR | 128 (default) | |
### photos
Field | Type | Length | Unsigned | Default
--- | --- | --- | --- | ---
id | INT | 10 | yes |
user_id | INT | 10 | yes | 0
url | VARCHAR | 128 (default) | |