docs/pages/client/introduction.mdx

18 lines
1.1 KiB
Plaintext
Raw Normal View History

2023-12-12 18:36:07 +00:00
---
title: 'Introduction'
---
2023-12-12 18:25:35 +00:00
2023-12-31 14:39:55 +00:00
# Introduction to the client
2023-12-12 21:27:15 +00:00
2023-12-31 14:39:55 +00:00
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.
2023-12-12 21:27:15 +00:00
2023-12-31 14:39:55 +00:00
## Progressive Web App
2023-12-12 21:27:15 +00:00
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 if not almost impossible 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](../self-hosting/about-pwa.mdx).
2023-12-12 21:27:15 +00:00
## Configuration
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](./deploy.mdx#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.
2023-12-31 14:39:55 +00:00
You can view all of the configuration options on the [configurations page](./configuration.mdx).