Skip to content

Commit 2324bb6

Browse files
committed
cleaning up
1 parent 6e76a86 commit 2324bb6

File tree

5 files changed

+13
-206
lines changed

5 files changed

+13
-206
lines changed

docs/configuration.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,10 +15,11 @@ For non-core options (for example UI options), take a look at [Settings](https:/
1515
| `TIMEZONE` | The timezone of your photos., requires a named timezone identifier like `Europe/Paris` | system timezone of server |
1616
| `LYCHEE_UPLOADS` | Path to uploads directory | `uploads/` inside `public/` |
1717
| `LYCHEE_UPLOADS_URL` | URL to uploads directory, better left empty | `/uploads` |
18+
| `APP_FORCE_HTTPS` | Force HTTPS on all URLs | `false` |
1819
| `TRUSTED_PROXIES` | Trusted proxy IP addresses | `null` |
1920
| `LOG_VIEWER_ENABLED` | Enable log viewer inside Lychee instead of through CLI. | `true` |
20-
| `LIVEWIRE_ENABLED` | Enable v5 Livewire frontend; set to `false` if the new frontend doesn't work on our installation (this is a **temporary** workaround). | `true` |
21-
21+
| `VUEJS_ENABLED` | Enable v6 Livewire frontend; set to `false` if the new frontend doesn't work on our installation (this is a **temporary** workaround). | `true` |
22+
| `LEGACY_API_ENABLED` | Enable the Legacy API, it will be enabled if `VUEJS_ENABLED` is set to `false`. | `false` |
2223

2324
> {note} `APP_URL` must only contain the hostname up to the Top Level Domain (tld) _e.g._ .com, .org etc.
2425
> If you are using Lychee in a sub folder, specify the path after the tld here in the `APP_DIR` constant.

docs/livewire.md

Lines changed: 0 additions & 159 deletions
This file was deleted.

docs/org.md

Lines changed: 0 additions & 36 deletions
This file was deleted.

docs/structure.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,13 @@ The `resources` directory contains your views as well as the TypeScript and CSS
3131

3232
### The Routes Directory
3333
The `routes` directory contains all of the route definitions for Lychee. Several route files are included with Lychee:
34-
`api.php`, `web-admin.php`, `web-install.php`, `web-livewire.php`, and `web.php`.
34+
`api-v1.php`, `api-v2.php`, `web-admin-v1.php`, `web-admin-v2.php`, `web-install.php`, `web-v1.php`, and `web-v2.php`.
35+
36+
This makes the separation between the two REST API:
37+
- `v1` routes are used by legacy endpoints, i.e. version 4 of Lychee. This is mostly used as POST requests.
38+
- `v2` routes are used by the Version 6 front-end with VueJs. It makes use of a more proper REST definition with PATCH, POST, GET and DELETE.
39+
40+
By default `v1` routes are disabled since version 6.
3541

3642
### The Storage Directory
3743
The `storage` directory contains your compiled Blade templates, file based sessions, file caches, and other files generated by the framework. This directory is segregated into `app`, `framework`, and `logs` directories. The `app` directory may be used to store any files generated by your application. The `framework` directory is used to store framework generated files and caches. Finally, the `logs` directory contains Laravel's log files (useful in case of hard crash).
@@ -53,7 +59,7 @@ The `vendor` directory contains your [Composer][2] dependencies.
5359
## The App Directory
5460
The majority of Lychee is housed in the `app` directory. By default, this directory is namespaced under `App` and is autoloaded by Composer using the [PSR-4 autoloading standard][3].
5561

56-
The `app` directory contains a variety of additional directories such as `Console`, `Http`, `Livewire` and `Providers`. Think of the `Console`, `Livewire`, and `Http` directories as providing an API into the core of your application. The HTTP protocol and CLI are both mechanisms to interact with Lychee, but do not actually contain application logic. In other words, they are two ways of issuing commands to Lychee. The `Console` directory contains all of the Artisan commands, while the `Http` directory contains your controllers, middleware, and requests. Furthermore the `Livewire` directory contains the serverside code necessary for the new front-end.
62+
The `app` directory contains a variety of additional directories such as `Console`, `Http`, and `Providers`. Think of the `Console` and `Http` directories as providing an API into the core of your application. The HTTP protocol and CLI are both mechanisms to interact with Lychee, but do not actually contain application logic. In other words, they are two ways of issuing commands to Lychee. The `Console` directory contains all of the Artisan commands, while the `Http` directory contains your controllers, middleware, and requests.
5763

5864
### The Console Directory
5965
The `Console` directory contains all of the custom Artisan commands for Lychee. These commands may be generated using the `make:command` command.
@@ -81,9 +87,6 @@ The `Image` directory contains our image handler. We provide here two ways to ma
8187
- with GD,
8288
- with imagick.
8389

84-
### The Livewire Directory
85-
The `Livewire` directory contains the server-side logic for the Livewire front-end. See more [here](livewire.html)
86-
8790
### The Metadata Directory
8891
The `Metatdata` directory contains logic related to data such as Exif information, geodecoding, lychee version, GitHub monitoring...
8992

gen.py

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,6 @@ def generate_base():
4242

4343
pages_title = {}
4444

45-
pages_title['org'] = 'Lychee & LycheeOrg'
4645
pages_title['releases'] = 'Release Notes'
4746

4847
pages_title['installation'] = 'Installation'
@@ -66,18 +65,17 @@ def generate_base():
6665
pages_title['architecture'] = 'Lychee logic overview'
6766
pages_title['structure'] = 'Directory Structure'
6867
pages_title['frontend'] = 'Front-end'
69-
pages_title['livewire'] = 'Livewire Front-end (alpha)'
7068

7169
structure = [['Prologue',
72-
['org', 'releases']]]
70+
['releases']]]
7371
structure += [['Getting Started',
7472
['installation', 'configuration', 'docker', 'update', 'upgrade']]]
7573
structure += [['Advanced Topics',
7674
['settings', 'keyboard', 'advanced-setups', 'honeypot', 'external_tracking']]]
7775
structure += [['Frequently Asked Question',
7876
['faq_general', 'faq_installation', 'faq_troubleshooting']]]
7977
structure += [['Contributing',
80-
['contributions', 'api', 'architecture', 'structure', 'frontend', 'livewire']]]
78+
['contributions', 'api', 'architecture', 'structure', 'frontend']]]
8179

8280

8381
def gen_github_link(page):

0 commit comments

Comments
 (0)