diff --git a/README.md b/README.md index d39fd37..7248cc2 100644 --- a/README.md +++ b/README.md @@ -82,7 +82,9 @@ return [ ### Database The recommended database for small website is sqlite. But you can also use postresql -Make sure to delete the existing migration scripts in your database/migrations folder. + +> [!CAUTION] +> Make sure to delete the existing migration scripts in your database/migrations folder. Then run: @@ -90,6 +92,26 @@ Then run: php artisan migrate ``` +### File Storage + +You can use your local filesystem or s3 compatible storage. Lucent expects you to have a valid configuration inside ``config/filesystems.php`` + +example: + +```php +return [ + 'disks' => [ + 'lucent' => [ + 'driver' => 'local', + 'root' => storage_path('app/public'), + 'url' => env('APP_URL').'/storage', + 'visibility' => 'public', + 'throw' => true, + ], + ], +]; +``` + ### First user To create your first user, head to your localhost:8000/lucent diff --git a/docs/Schemas.md b/docs/Schemas.md index 754fe3f..dfda485 100644 --- a/docs/Schemas.md +++ b/docs/Schemas.md @@ -24,7 +24,8 @@ There are 3 types of schemas - **fields**: The list of your fields. Look the field reference for more - **isEntry**: If this schema is important, it will show be visible on the main the sidebar. Default: false _optional_ - **sortBy**: The default sorting in the content browser _optional_ -- **titleTemplate**: Mustache code to customize the preview field _optional_ +- **cardTitle**: Mustache code to customize the preview field _optional_ +- **cardImage**: Field name of image you want to use as a preview image _optional_ - **revisions**: How many revisions are going to be kept for each record _optional_ - **read**: Array of user groups that have read permissions _optional_ - **write**: Array of user groups that have write permissions _optional_ @@ -40,20 +41,12 @@ There are 3 types of schemas - **fields**: The list of your fields. Look the field reference for more - **isEntry**: If this schema is important, it will show be visible on the main the sidebar _optional_ - **sortBy**: The default sorting in the content browser _optional_ -- **titleTemplate**: Mustache code to customize the preview field _optional_ +- **cardTitle**: Mustache code to customize the preview field _optional_ - **revisions**: How many revisions are going to be kept for each record _optional_ - **read**: Array of user groups that have read permissions _optional_ - **write**: Array of user groups that have write permissions _optional_ -## Block Reference - -- **name**: The ID of the collection. Camelcase and plural is the recommended format ex. blogPosts -- **label**: The friendly name of the schema -- **type**: The type of the collection. Should be "block" -- **fields**: The list of your fields. Look the field reference for more - - A full Collection example without the fields: ```json @@ -74,7 +67,8 @@ A full Collection example without the fields: "SEO" ], "sortBy": "-_sys.createdAt", - "titleTemplate": "{{name}} {{slug}}", + "schemaTitle": "{{name}} {{slug}}", + "schemaImage": "cover", "revisions": 15, "read": [ "admin",