# Installation The instructions below will help you to properly installand run the generated package to the lavalite project. ## Location Extract the package contents to the folder `/packages/love/love_spell/` ## Composer Add the below entries in the `composer.json`. ```json ... "repositories": { ... { "type": "path", "url": "packages/love/love_spell" } ... }, ... ``` Then run `composer require love/love_spell` ## Migration and seeds ``` php artisan migrate php artisan db:seed --class=Love\\LoveSpell\\Seeders\\LoveSpellTableSeeder ``` ## Publishing * Configuration ``` php artisan vendor:publish --provider="Love\LoveSpell\Providers\LoveSpellServiceProvider" --tag="config" ``` * Language ``` php artisan vendor:publish --provider="Love\LoveSpell\Providers\LoveSpellServiceProvider" --tag="lang" ``` * Views ``` php artisan vendor:publish --provider="Love\LoveSpell\Providers\LoveSpellServiceProvider" --tag="view" ``` ## URLs and APIs ### Web Urls * Admin ``` http://path-to-route-folder/admin/love_spell/{modulename} ``` * User ``` http://path-to-route-folder/user/love_spell/{modulename} ``` * Public ``` http://path-to-route-folder/love_spells ``` ### API endpoints These endpoints can be used with or without `/api/` And also the user can be varied depend on the type of users, eg user, client, admin etc. #### Resource * List ``` http://path-to-route-folder/api/user/love_spell/{modulename} METHOD: GET ``` * Create ``` http://path-to-route-folder/api/user/love_spell/{modulename} METHOD: POST ``` * Edit ``` http://path-to-route-folder/api/user/love_spell/{modulename}/{id} METHOD: PUT ``` * Delete ``` http://path-to-route-folder/api/user/love_spell/{modulename}/{id} METHOD: DELETE ``` #### Public * List ``` http://path-to-route-folder/api/love_spell/{modulename} METHOD: GET ``` * Single Item ``` http://path-to-route-folder/api/love_spell/{modulename}/{slug} METHOD: GET ``` #### Others * Report ``` http://path-to-route-folder/api/user/love_spell/{modulename}/report/{report} METHOD: GET ``` * Export/Import ``` http://path-to-route-folder/api/user/love_spell/{modulename}/exim/{exim} METHOD: POST ``` * Action ``` http://path-to-route-folder/api/user/love_spell/{modulename}/action/{id}/{action} METHOD: PATCH ``` * Actions ``` http://path-to-route-folder/api/user/love_spell/{modulename}/actions/{action} METHOD: PATCH ``` * Workflow ``` http://path-to-route-folder/api/user/love_spell/{modulename}/workflow/{id}/{transition} METHOD: PATCH ```