vnpower/pixivfe
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

README: rewrite a lot of stuff

Browse source
This commit is contained in:
VnPower 2023-06-05 20:33:14 +07:00
parent 867b82562e
commit 9dcf31f420
Signed by: vnpower
GPG key ID: 881DE3DEB966106C
1 changed files with 28 additions and 24 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

52
README.md
View file

@ -8,30 +8,15 @@ A privacy-respecting alternative front-end for Pixiv that doesn't suck
</a>
</p>
## What is this?
## Features
This is an alternative front-end for Pixiv, also my second Go project, so the code may not look good for those who are experienced :(
**Why?** Because nobody made a front-end for Pixiv that I like.
Note that this project is still under its preparation stage.
## Previews
~~Homepage: currently contains recommended works, daily rankings, pixivision's articles and newest works on Pixiv. Route: `/`~~ Previously this was made possible by using an external API. Currently, I had switched to Pixiv's ajax API, so the index page won't be available for now.
![Homepage](https://files.catbox.moe/053fzh.png)
![Homepage](https://files.catbox.moe/m64h7s.png)
Artwork's page: informations about the artwork, recent artworks by the artist and related artworks. Route: `/artworks/<id>` (id for the preview: 107664519)
![Artwork](https://files.catbox.moe/x3k85p.png)
![Artwork](https://files.catbox.moe/ocy4fq.png)
User's page: Route: `/user/<id>` (id for the preview: 11065404)
![User](https://files.catbox.moe/f055gn.png)
- Lightweight - both the interface and the code
- Privacy-first - the server will do the work for you
- No bloat - HTML and CSS, with minimal JS to enhance the interface
- Open source - you can trust me!
## Installation
This project only depends on one Go library: [Gin](https://github.com/gin-gonic/gin)
Run these commands below, then access the site on [localhost:8080](https://localhost:8080)
```
@ -43,11 +28,30 @@ cp config.example.yml config.yml # config file
You will have to add your own `PHPSESSID` in order to run. Go to `config.yml` for more details.
## Self-host guide
WIP
## Instances
Official instance: [https://pixivfe.exozy.me](https://pixivfe.exozy.me)
I don't know how to write a self-host guide so you will have to wait :P
## Previews
Landing page: currently borked :(
Most pages are very similar to each other. So I will only take screenshots of the artwork page and the user page, since they are the most unique.
Artwork page ([URL to this page](https://pixivfe.exozy.me/artworks/108672057)):
![Artwork](https://files.catbox.moe/c3l1vm.png)
![Artwork](https://files.catbox.moe/f9o0h0.png)
![Artwork](https://files.catbox.moe/9yc2yk.png)
User page ([URL to this page](https://pixivfe.exozy.me/users/11764388)):
![User](https://files.catbox.moe/tdc234.png)
<!-- ![Homepage](https://files.catbox.moe/053fzh.png) -->
<!-- ![Homepage](https://files.catbox.moe/m64h7s.png) -->
## To-do
@ -62,7 +66,7 @@ I don't know how to write a self-host guide so you will have to wait :P
- [x] Daily rankings
- [x] Spotlight (pixivision)
- [ ] Discovery
- [ ] Artworks
- [x] Artworks
- [ ] Users
- [x] Newest by all
- [ ] Trending tags
@ -75,7 +79,7 @@ I don't know how to write a self-host guide so you will have to wait :P
- [ ] Recommended artworks
- [x] Daily rankings
- [ ] Discovery
- [ ] Artworks
- [x] Artworks
- [ ] Users
- [x] Newest by all
- [x] Search results
@ -95,4 +99,4 @@ I don't know how to write a self-host guide so you will have to wait :P
## License
[~~MIT~~](https://mit-license.org/) [AGPL3](https://www.gnu.org/licenses/agpl-3.0.txt)
[AGPL3](https://www.gnu.org/licenses/agpl-3.0.txt)