proxitok/README.md

# ProxiTok
Use Tiktok with an alternative frontend, inspired by Nitter.

## Features
* Privacy: All requests made to TikTok are server-side, so you will never connect to their servers
* See user's feed
* See trending and discovery tab
* See tags
* See video by id
* Themes
* RSS Feed for user, trending and tag (just add /rss to the url)

## Self-hosting
Please check [this](https://github.com/pablouser1/ProxiTok/wiki/Self-hosting) wiki article for info on how to self-host your own instance

## Public instances
[This](https://github.com/pablouser1/ProxiTok/wiki/Public-instances) wiki article contains a list with all the known public instances.

## Extensions
If you want to automatically redirect Tiktok links to ProxiTok you can use:
* [Libredirect](https://github.com/libredirect/libredirect)
* [Redirector](https://github.com/einaregilsson/Redirector)

You can use the following config if you want to use Redirector (you can change https://proxitok.pabloferreiro.es with whatever instance you want to use):
```
Description: TikTok to ProxiTok
Example URL: https://www.tiktok.com/@tiktok
Include pattern: (.*//.*)(tiktok.com)(.*)
Redirect to: https://proxitok.pabloferreiro.es$3
Example result: https://proxitok.pabloferreiro.es/@tiktok
Pattern type: Regular Expression
Apply to: Main window (address bar)
```

## TODO / Known issues
* Replace placeholder favicon
* Make video on /video fit screen and don't overflow
* Fix embed styling
* Fix crash when invalid vm.tiktok.com/CODE or www.tiktok.com/t/CODE is provided
* Add custom amount of videos per page

## Credits
* [TheFrenchGhosty](https://thefrenchghosty.me) ([Github](https://github.com/TheFrenchGhosty)): Initial Dockerfile and fixes to a usable state.
* [Jennifer Wjertzoch](https://wjertzochjennifer.medium.com): Carousel CSS Implementation

### External libraries
* [TikScraperPHP](https://github.com/pablouser1/TikScraperPHP)
* [Latte](https://github.com/nette/latte)
* [bramus/router](https://github.com/bramus/router)
* [PHP dotenv](https://github.com/vlucas/phpdotenv)
* [Bulma](https://github.com/jgthms/bulma) and [Bulmaswatch](https://github.com/jenil/bulmaswatch)
Project name change 2022-01-14 12:18:28 -05:00			`# ProxiTok`
			`Use Tiktok with an alternative frontend, inspired by Nitter.`
First commit 2022-01-01 14:14:57 -05:00
(even) better gif loader, scss support 2022-01-06 18:13:51 -05:00			`## Features`
Project name change 2022-01-14 12:18:28 -05:00			`* Privacy: All requests made to TikTok are server-side, so you will never connect to their servers`
(even) better gif loader, scss support 2022-01-06 18:13:51 -05:00			`* See user's feed`
Icons, themes, removed instance proxy and more 2022-03-29 13:30:31 -04:00			`* See trending and discovery tab`
(even) better gif loader, scss support 2022-01-06 18:13:51 -05:00			`* See tags`
Patching system, video by id 2022-01-08 10:03:57 -05:00			`* See video by id`
Icons, themes, removed instance proxy and more 2022-03-29 13:30:31 -04:00			`* Themes`
RSS initial support 2022-01-28 09:54:09 -05:00			`* RSS Feed for user, trending and tag (just add /rss to the url)`
(even) better gif loader, scss support 2022-01-06 18:13:51 -05:00
Added public instances section on README 2022-03-18 11:01:10 -04:00			`## Self-hosting`
			`Please check [this](https://github.com/pablouser1/ProxiTok/wiki/Self-hosting) wiki article for info on how to self-host your own instance`

			`## Public instances`
			`[This](https://github.com/pablouser1/ProxiTok/wiki/Public-instances) wiki article contains a list with all the known public instances.`

hotfix 2022-03-11 18:34:42 -05:00			`## Extensions`
Added Redirector 2022-03-11 10:11:56 -05:00			`If you want to automatically redirect Tiktok links to ProxiTok you can use:`
			`* [Libredirect](https://github.com/libredirect/libredirect)`
			`* [Redirector](https://github.com/einaregilsson/Redirector)`

Example Redirector config change I changed the example Redirector config to use the new official instance instead of the old Heroku one. 2022-09-06 03:00:00 -04:00			`You can use the following config if you want to use Redirector (you can change https://proxitok.pabloferreiro.es with whatever instance you want to use):`
Added Redirector 2022-03-11 10:11:56 -05:00			```
			`Description: TikTok to ProxiTok`
			`Example URL: https://www.tiktok.com/@tiktok`
			`Include pattern: (.//.)(tiktok.com)(.*)`
Example Redirector config change I changed the example Redirector config to use the new official instance instead of the old Heroku one. 2022-09-06 03:00:00 -04:00			`Redirect to: https://proxitok.pabloferreiro.es$3`
			`Example result: https://proxitok.pabloferreiro.es/@tiktok`
Added Redirector 2022-03-11 10:11:56 -05:00			`Pattern type: Regular Expression`
			`Apply to: Main window (address bar)`
			```
Update README.md 2022-03-05 16:50:47 -05:00
Accept chromedriver url for sign and .env cleanup 2022-03-13 18:18:10 -04:00			`## TODO / Known issues`
temp favicon, updated scrapper and .env changes 2022-08-13 07:09:39 -04:00			`* Replace placeholder favicon`
Patching system, video by id 2022-01-08 10:03:57 -05:00			`* Make video on /video fit screen and don't overflow`
WIP embed.js support and robots.txt 2022-04-10 06:10:48 -04:00			`* Fix embed styling`
New TODOS 2022-06-16 05:47:42 -04:00			`* Fix crash when invalid vm.tiktok.com/CODE or www.tiktok.com/t/CODE is provided`
			`* Add custom amount of videos per page`
Hash system and controls inside player 2022-01-01 18:06:00 -05:00
First commit 2022-01-01 14:14:57 -05:00			`## Credits`
pictures using carousel 2023-04-01 11:09:12 -04:00			`* [TheFrenchGhosty](https://thefrenchghosty.me) ([Github](https://github.com/TheFrenchGhosty)): Initial Dockerfile and fixes to a usable state.`
			`* [Jennifer Wjertzoch](https://wjertzochjennifer.medium.com): Carousel CSS Implementation`
Update the credits, deprecate my image 2022-12-21 11:37:23 -05:00
Added Credits for Dockerfile 2022-03-15 18:57:48 -04:00			`### External libraries`
hotfix 2022-03-11 18:34:42 -05:00			`* [TikScraperPHP](https://github.com/pablouser1/TikScraperPHP)`
Removed Following (use RSS), allow unix for Redis 2022-02-06 08:22:23 -05:00			`* [Latte](https://github.com/nette/latte)`
RSS initial support 2022-01-28 09:54:09 -05:00			`* [bramus/router](https://github.com/bramus/router)`
Changed rendering template and router 2022-01-03 07:43:22 -05:00			`* [PHP dotenv](https://github.com/vlucas/phpdotenv)`
Using new RSS wrapper 2022-01-30 18:42:20 -05:00			`* [Bulma](https://github.com/jgthms/bulma) and [Bulmaswatch](https://github.com/jenil/bulmaswatch)`