#11 Add a default config file

Author: alies-dev

README.md

@@ -23,6 +23,14 @@ composer require interaction-design-foundation/nova-unlayer-field
 ⚠️ For PHP 7.1 - PHP 7.4 please use [version 0.2.2](https://github.com/InteractionDesignFoundation/nova-unlayer-field/tree/0.2.2) (it uses another namespace).
 
 
+### Optional: publish the configuration
+
+Run this on the command line from the root of your project:
+```sh
+php artisan vendor:publish --provider="InteractionDesignFoundation\NovaUnlayerField\ServiceProvider" --tag=config
+```
+
+
 ## Usage
 
 This package assumes that your Model has an attribute to store design config
@@ -40,7 +48,7 @@ public function fields()
             'projectId' => config('unlayer.project_id'),
 
             // optional
-            'templateId' => config('unlayer.newsletter_template_id'), // Used only if bound attribute ('design' in this case) is empty.
+            'templateId' => config('unlayer.template_id'), // Used only if bound attribute ('design' in this case) is empty.
             'displayMode' => 'web', // "email" or "web". Default value: "email"
             'locale' => 'es', // Locale for Unlayer UI. Default value: application’s locale.
         ]),

config.php

@@ -0,0 +1,27 @@
+<?php declare(strict_types=1);
+
+return [
+    /*
+    |--------------------------------------------------------------------------
+    | Unlayer Project ID
+    |--------------------------------------------------------------------------
+    | This is the project ID from Unlayer. You can get it from the project settings page:
+    | 1. Log in to the Unlayer dabshboard and open https://dashboard.unlayer.com/projects
+    | 2. Select or create a Project from, URL will be like https://dashboard.unlayer.com/projects/1234/design/templates, where 1234 is a project ID.
+    */
+    'project_id' => env('UNLAYER_PROJECT_ID'),
+
+    /*
+    |--------------------------------------------------------------------------
+    | Unlayer Project ID
+    |--------------------------------------------------------------------------
+    | Templates are pre-built designs that can be loaded into the editor
+    | so your users don't have to start creating everything from scratch in a blank editor.
+    | @see https://docs.unlayer.com/docs/templates
+    |
+    | To find your project ID:
+    | 1. Open Unlayer dabshboard and open https://dashboard.unlayer.com/projects
+    | 2. Select a project and template, URL will be like https://dashboard.unlayer.com/projects/42/design/templates/43, where 42 is a project ID, 43 is a temple ID.
+    */
+    'template_id' => env('UNLAYER_TEMPLATE_ID'),
+];

src/ServiceProvider.php

@@ -19,6 +19,10 @@ public function boot(): void
         ]);
 
         $this->registerTranslations();
+
+        if ($this->app->runningInConsole()) {
+            $this->registerResources();
+        }
     }
 
     protected function registerTranslations(): void
@@ -28,4 +32,11 @@ protected function registerTranslations(): void
         Nova::translations(__DIR__."/../resources/lang/$currentLocale.json");
         Nova::translations(resource_path("lang/vendor/nova-unlayer-field/$currentLocale.json"));
     }
+
+    private function registerResources(): void
+    {
+        $this->publishes([
+            __DIR__ . '/../config/unlayer.php' => config_path('unlayer.php'),
+        ], 'config');
+    }
 }