Files
PixivFE/README.md
T
2024-02-18 15:49:04 +11:00

5.0 KiB

PixivFE

A privacy-respecting alternative front-end for Pixiv that doesn't suck.

Get it on Codeberg

CI badge Go Report Card

Questions? Feedback? You can PM me on Matrix! You can also see the Known quirks page to check if your issue has a known solution.

You can keep track of this project's development using the roadmap.

Features

  • Lightweight - both the interface and the code
  • Privacy-first - the server will do the work for you
  • No bloat - we only serve HTML, CSS and minimal JS code
  • Open source - you can trust me!

Hosting

You can use PixivFE for personal use! Assuming that you use an operating system that can run POSIX shell scripts, install go, clone this repository, modify the run.sh file, and profit! I recommend self-hosting your own instance for personal use, instead of relying entirely on official instances.

To deploy PixivFE using Docker or the compiled binary, see the Hosting PixivFE wiki page. A guide on hosting a Pixiv image proxy is also available if you don't want to use a public one.

Development

Requirements:

  • pnpm (to install Sass)
  • go (to build PixivFE from source)
# Clone the PixivFE repository
git clone https://codeberg.org/VnPower/PixivFE.git && cd PixivFE

# Install Sass globally using pnpm
pnpm i -g sass

# Compile styles using Sass and watch for changes
sass --watch ./views/css

# Run in PixivFE in development mode (templates reload automatically)
PIXIVFE_DEV=1 <other_environment_variables> go run .

Instances

Name URL Country Cloudflare? Mozilla Observatory grade Uptime
exozyme (Official) https://pixivfe.exozy.me US No Mozilla HTTP Observatory Grade Uptime Robot status Uptime Robot ratio (30 days)
dragongoose https://pixivfe.drgns.space US No Mozilla HTTP Observatory Grade Uptime Robot status Uptime Robot ratio (30 days)
ducks.party https://pixivfe.ducks.party NL No Mozilla HTTP Observatory Grade Uptime Robot status Uptime Robot ratio (30 days)
perennialte.ch https://pixiv.perennialte.ch AU No Mozilla HTTP Observatory Grade Uptime Robot status Uptime Robot ratio (30 days)

If you are hosting your own instance, you can create a pull request to add it here!

For more information on instance uptime, see the PixivFE instance status page.

License

License: AGPL3