Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
tunecino authored Jul 7, 2017
1 parent 1ce5d26 commit c0c4f09
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,18 +5,18 @@ yii2-app-builder

This is a fork of [yiisoft/yii2-app-advanced](https://github.com/yiisoft/yii2-app-advanced) template to which I have added the following:

- **api** folder as implementation of [Yii2 RESTful API framework](http://www.yiiframework.com/doc-2.0/guide-rest-quick-start.html)
- **auth** folder to proved access/refresh tokens as implementation of [OAuth 2.0](https://tools.ietf.org/html/rfc6749). *(documentation and examples to be added later)*
- :file_folder:`api` folder as implementation of [Yii2 RESTful API framework](http://www.yiiframework.com/doc-2.0/guide-rest-quick-start.html)
- :file_folder:`auth` folder to proved access/refresh tokens as implementation of [OAuth 2.0](https://tools.ietf.org/html/rfc6749). *(documentation and examples to be added later)*
- [tunecino/yii2-schema-builder](https://github.com/tunecino/yii2-schema-builder) extension to both `frontend` and `api` apps.

My plan is to keep this fork up-to-date with the official template while keep improving the builder and RESTful related stuff.
The plan is to keep this fork up-to-date with official template while keep improving builder & RESTful related stuff.

## Installation
Installation is similar to [yiisoft/yii2-app-advanced](https://github.com/yiisoft/yii2-app-advanced) template. see [full steps here](https://github.com/yiisoft/yii2-app-advanced/blob/master/docs/guide/start-installation.md). Except that the composer command for this fork is:
Installation is almost similar to [yiisoft/yii2-app-advanced](https://github.com/yiisoft/yii2-app-advanced) template. see [full steps here](https://github.com/yiisoft/yii2-app-advanced/blob/master/docs/guide/start-installation.md). Except that the composer command for this fork is:
```
composer create-project --prefer-dist tunecino/yii2-app-builder your-app-name
```
And extra server configurations for `api.dev` and `auth.dev` should be made same as it is done for `frontend.dev` and `backend.dev`. Alternatively you can also use vagrant.

## Usage
After installing the template, configuring DB and init the dev mode, go to either `frontend.dev/builder` or `api.dev/builder`, use the [GUI](https://github.com/tunecino/yii2-schema-builder) to prototype your app then hit that Generate button. If it says DONE, the preview link of each entity should take you to a working app.
After installing the template, configuring DB and init the dev mode, go to either `frontend.dev/builder` or `api.dev/builder`, use the [GUI](https://github.com/tunecino/yii2-schema-builder) to prototype your app then hit that Generate button. If it says DONE, the preview link of each entity should take you to a working app.

0 comments on commit c0c4f09

Please sign in to comment.