lucent/lucent-laravel
2
0
Fork 0
Code Issues 14 Pull Requests Releases 1 Activity

updated readme

Browse Source
This commit is contained in:
Alex Lingris
2024-08-23 21:06:53 +03:00
parent a737c2d571
commit 9e140be0ec
2 changed files with 28 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+23 -1
View File
@@ -82,7 +82,9 @@ return [
### Database ### Database
The recommended database for small website is sqlite. But you can also use postresql 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: Then run:
@@ -90,6 +92,26 @@ Then run:
php artisan migrate 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 ### First user
To create your first user, head to your localhost:8000/lucent To create your first user, head to your localhost:8000/lucent
docs/Schemas.md
+5 -11
View File
@@ -24,7 +24,8 @@ There are 3 types of schemas
- **fields**: The list of your fields. Look the field reference for more - **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_ - **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_ - **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_ - **revisions**: How many revisions are going to be kept for each record _optional_
- **read**: Array of user groups that have read permissions _optional_ - **read**: Array of user groups that have read permissions _optional_
- **write**: Array of user groups that have write 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 - **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_ - **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_ - **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_ - **revisions**: How many revisions are going to be kept for each record _optional_
- **read**: Array of user groups that have read permissions _optional_ - **read**: Array of user groups that have read permissions _optional_
- **write**: Array of user groups that have write 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: A full Collection example without the fields:
```json ```json
@@ -74,7 +67,8 @@ A full Collection example without the fields:
"SEO" "SEO"
], ],
"sortBy": "-_sys.createdAt", "sortBy": "-_sys.createdAt",
"titleTemplate": "{{name}} {{slug}}", "schemaTitle": "{{name}} {{slug}}",
"schemaImage": "cover",
"revisions": 15, "revisions": 15,
"read": [ "read": [
"admin", "admin",