Website-Finder/Webpage/README.md

44 lines
1.6 KiB
Markdown
Raw Permalink Normal View History

2023-03-08 01:48:47 +01:00
# Website-Finder: Webpage
2022-12-11 20:00:36 +01:00
2023-03-08 01:48:47 +01:00
This version of Website-Finder differs a lot from the scripts available in this repository, as it runs in a web browser and uses external dependencies to look fancy
2023-03-08 12:51:22 +01:00
The reason why is because this version is geared towards people who just want something cool-looking that does something cool, without the hassle of installing a new programming language
![Check out the preview video!](preview.mp4)
2023-03-08 12:51:22 +01:00
2022-12-11 20:00:36 +01:00
## HOW TO RUN
2023-03-08 01:48:47 +01:00
It is already being run on [finder.taevas.xyz](https://finder.taevas.xyz), but you may run it yourself simply by cloning the repository and opening index.html in your web browser
2022-12-11 20:00:36 +01:00
Do note that using arguments and launching the search is done through the HTML, so you cannot use the cli/terminal to use arguments, and opening the file will not instantly trigger the search
```sh
# You should be able to double-click the file or drag the file to the web browser, but if you wanna be fancy
# Linux
$ xdg-open index.html
# Windows
2022-12-11 20:00:36 +01:00
$ explorer index.html
# macOS
$ open index.html
```
## REGARDING REPORTS
Your web browser should be unable to create files on your computer, so unlike other scripts, no report in json is made
Instead, a report is created in real time within the HTML, and some logging is done in the browser console
2022-12-11 20:00:36 +01:00
## REGARDING ARGUMENTS
If the page is served to you through HTTPS, you likely won't be able to use the HTTP application protocol due to [Mixed Content](https://developer.mozilla.org/en-US/docs/Web/Security/Mixed_content)
2022-12-11 20:00:36 +01:00
2023-03-08 01:48:47 +01:00
The default arguments do not match the ones specified in [defaults.json](../defaults.json)
2022-12-11 20:00:36 +01:00
## OTHER STUFF
More details are available on [the readme in the root folder](../README.md)