Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/pixiv-cat/pixivcat-backend

Pixiv.cat backend server
https://github.com/pixiv-cat/pixivcat-backend

expressjs pixiv

Last synced: 2 months ago
JSON representation

Pixiv.cat backend server

Host: GitHub
URL: https://github.com/pixiv-cat/pixivcat-backend
Owner: pixiv-cat
License: mit
Created: 2024-03-11T13:03:16.000Z (11 months ago)
Default Branch: main
Last Pushed: 2024-10-20T17:16:58.000Z (3 months ago)
Last Synced: 2024-10-20T20:52:31.798Z (3 months ago)
Topics: expressjs, pixiv
Language: JavaScript
Homepage: https://pixiv.cat/
Size: 367 KB
Stars: 35
Watchers: 2
Forks: 3
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# Pixiv.cat backend server
This is the backend server for [Pixiv.cat](https://pixiv.cat/), a project that serves as a proxy for Pixiv images.

## Getting Started

### Prerequisites
* Node.js
* npm
* Memcached - For API response caching

### Installing

#### Option 1: Using Docker (Suggested)
1. Clone the repository
```
git clone https://github.com/pixiv-cat/pixivcat-backend.git
```
2. Create a `.env` file in the root directory and set up your environment variables based on the provided [.env.example](.env.example).

To authenticate with Pixiv, you will need to obtain a refresh token (or more than one) from Pixiv.

Please see [here](https://gist.github.com/ZipFile/c9ebedb224406f4f11845ab700124362) for detailed instructions on how to obtain it.
3. Run `docker compose up` to start the server.

#### Option 2: Local Development
1. Clone the repository
```
git clone https://github.com/pixiv-cat/pixivcat-backend.git
```
2. Install NPM packages
```
npm install
```
3. Create a `.env` file in the root directory and set up your environment variables based on the provided [.env.example](.env.example).