pixivfe/README.md

87 lines
2.3 KiB
Markdown
Raw Normal View History

2023-05-13 03:48:35 +00:00
# PixivFE
A privacy-respecting alternative front-end for Pixiv that doesn't suck
## What is this?
2023-05-17 13:11:53 +00:00
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 :(
2023-05-13 03:48:35 +00:00
2023-05-17 13:11:53 +00:00
**Why?** Because nobody made a front-end that I like.
2023-05-13 03:48:35 +00:00
Note that this project is still under its preparation stage.
2023-05-17 13:11:53 +00:00
It is not prepared for production, or to be called a "real alternative front-end", yet.
2023-05-13 03:48:35 +00:00
2023-05-14 13:35:50 +00:00
## Previews
Homepage: currently contains recommended works, daily rankings, pixivision's articles and newest works on Pixiv. Route: `/`
![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)
2023-05-13 12:25:12 +00:00
## Installation
Run these commands below, then access the site on [localhost:8080](https://localhost:8080)
```
git clone https://codeberg.org/VnPower/pixivfe.git
cd pixivfe
go install main.go
go run main.go
```
## To-do
- [ ] Base
- [ ] Navigation bar
- [ ] Searching
- [ ] Pagination
2023-05-17 13:11:53 +00:00
- [ ] Configuration file
- [ ] Write a real independent API
2023-05-13 12:25:12 +00:00
- [ ] Index page
- [x] Recommended artworks
- [x] Daily rankings
2023-05-13 14:33:40 +00:00
- [x] Spotlight (pixivision)
2023-05-13 12:25:12 +00:00
- [ ] Discovery
- [ ] Artworks
- [ ] Users
2023-05-14 04:11:44 +00:00
- [x] Newest by all
2023-05-14 13:21:41 +00:00
- [ ] Trending tags
2023-05-13 12:25:12 +00:00
- [ ] Switcher (illusts/mangas)
- [ ] Single pages
2023-05-17 13:11:53 +00:00
- [x] User
2023-05-14 13:21:41 +00:00
- [x] Artwork
2023-05-13 12:25:12 +00:00
- [ ] Spotlight
- [ ] List pages
- [ ] Recommended artworks
- [ ] Daily rankings
- [ ] Discovery
- [ ] Artworks
- [ ] Users
- [ ] Newest by all
- [ ] Search results
- [ ] Switcher
- [ ] Settings
- [ ] Login
- [ ] Local history
- [ ] Toggling R-18, R-18G, AI
- [ ] Custom `pximg` proxy
2023-05-14 13:21:41 +00:00
- [ ] Optimization
2023-05-17 13:11:53 +00:00
- [x] Split web components into smaller templates
2023-05-16 05:29:17 +00:00
- [x] Clean the models + JSON
2023-05-17 08:30:57 +00:00
- [x] Navigation between pages
2023-05-17 13:11:53 +00:00
- [x] Lazy load images
- [ ] Better error handling
- [ ] Fully proxy images from Pixiv
2023-05-13 12:25:12 +00:00
2023-05-13 03:48:35 +00:00
## License
This project was made for learning and experimental purposes.
2023-05-15 00:28:10 +00:00
[~~MIT~~](https://mit-license.org/) [AGPL3](https://www.gnu.org/licenses/agpl-3.0.txt)