https://github.com/blackbes/yii2-yiireact

Yii2 extension for support a react-based frontend.
https://github.com/blackbes/yii2-yiireact

react yii2 yii2-extension yii2-framework yii2-gii yii2-react

Last synced: 2 months ago
JSON representation

Yii2 extension for support a react-based frontend.

• Host: GitHub
• URL: https://github.com/blackbes/yii2-yiireact
• Owner: BlackBes
• License: mit
• Created: 2020-12-25T08:48:13.000Z (about 4 years ago)
• Default Branch: master
• Last Pushed: 2021-01-02T16:31:13.000Z (about 4 years ago)
• Last Synced: 2024-10-10T22:02:18.840Z (3 months ago)
• Topics: react, yii2, yii2-extension, yii2-framework, yii2-gii, yii2-react
• Language: PHP
• Homepage:
• Size: 25.4 KB
• Stars: 2
• Watchers: 3
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
React integration for Yii2

===================

[![Hits](https://hits.seeyoufarm.com/api/count/incr/badge.svg?url=https%3A%2F%2Fgithub.com%2FBlackBes%2Fyii2-yiireact&count_bg=%2379C83D&title_bg=%23555555&icon=php.svg&icon_color=%236B7DB0&title=hits&edge_flat=false)](https://hits.seeyoufarm.com)

Yii2 extension for support a react-based frontend.

Installation

------------

The preferred way to install this extension is through [composer](http://getcomposer.org/download/).

Either run

```

php composer.phar require --prefer-dist blackbes/yii2-yiireact "*"

```

or add

```

"blackbes/yii2-yiireact": "*"

```

to the require section of your `composer.json` file.

Usage

-----

Once the extension is installed, add this code to your web.php into `$config['modules']['gii']` :

```php

'generators' => [ //here

    'yiiReact' => [

        'class' => 'blackbes\yiireact\yiiReactCrud\Generator',

        'templates' => [

    'react' => 'blackbes/yiireact/yiiReactCrud/default',

        ]

    ]

],

```

If done correctly, you can now access React API CRUD Generator in Yii2 Gii

Usage instructions

----

First of all make sure that you have installed [react-yii2-essentials](https://github.com/BlackBes/react-yii2-essentials) extension on your React part of the project.

If it is installed then:

1) Create any Model using Gii Model generator

2) Make newly generated model extend `blackbes\yiireact\models\ParentModel`

3) Use installed React API CRUD Generator for this model. It will generate a Model Controller in `/controllers/api/`

and all pages with forms for React in `/views/api//`.

4) Create `src/containers` folder in the root directory of your React project

5) Copy the `/views/api//` from Yii2 and paste it into `src/containers` directory of your React

project

6) Use `_routes.js` to add routes and import generated files

## Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

License

-------

MIT Licence, © [BlackBes](https://github.com/BlackBes).