Initial draft

This commit is contained in:
qtchaos
2023-12-31 16:39:55 +02:00
parent baf2169306
commit 86cd905dc8
40 changed files with 2461 additions and 2909 deletions

View File

@@ -1,16 +1,17 @@
---
title: 'Introduction'
---
# Introduction to the client
The client is what the main part of the application, it houses the interface and all of the scraping logic.
The client is what users sees when navigating to your domain, it's the main part of the application and houses the interface and all of the scraping logic.
## PWA
## Progressive Web App
The client can be optionally ran as a PWA. This can be hard to do correctly and really hard to reverse, so it's generally not recommended to do so if you don't have experience hosting PWA's.
You can read more about it [here](../1.self-hosting/3.about-pwa.md).
The client can be optionally ran as a [PWA](https://web.dev/explore/progressive-web-apps), which allows it to be installed on a mobile device. This can be hard to do correctly and really hard to reverse, so it's generally not recommended to do so if you don't have experience hosting PWAs. If you understand the risks and still want to continue, then read more about it [here](../1.self-hosting/3.about-pwa.md).
## Configuration
The client has a decent amount of configuration options. You can view them all [here](./3.configuration.md).
The client features various configuration options, some of which are required for the client to function. [If you are using Vercel to host the client](1.deploy.md#method-1-vercel-recommended), then the required variables are a necessary part of creating the site, if you're using another host, or hosting it for yourself, you'll need to set them up yourself.
You can view all of the configuration options on the [configurations page](3.configuration.md).