creations/booru-api
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
A simple Booru API written in TypeScript with support for multiple Boorus and Docker compatibility.
8 commits 2 branches 0 tags 128 KiB
Find a file
creations 1ab25bd4f6
update readme
2025-01-05 20:52:22 -05:00
.vscode first commit 2024-12-28 09:13:34 -05:00
config add docker support, move to env file, add example 2025-01-05 20:48:29 -05:00
src add docker support, move to env file, add example 2025-01-05 20:48:29 -05:00
types add random, add autocomplete, more smaller changes 2025-01-05 20:03:30 -05:00
.editorconfig first commit 2024-12-28 09:13:34 -05:00
.example.env add docker support, move to env file, add example 2025-01-05 20:48:29 -05:00
.gitattributes first commit 2024-12-28 09:13:34 -05:00
.gitignore add docker support, move to env file, add example 2025-01-05 20:48:29 -05:00
compose.yml add docker support, move to env file, add example 2025-01-05 20:48:29 -05:00
Dockerfile add docker support, move to env file, add example 2025-01-05 20:48:29 -05:00
eslint.config.js first commit 2024-12-28 09:13:34 -05:00
LICENSE first commit 2024-12-28 09:14:12 -05:00
package.json add docker support, move to env file, add example 2025-01-05 20:48:29 -05:00
README.md update readme 2025-01-05 20:52:22 -05:00
tsconfig.json first commit 2024-12-28 09:13:34 -05:00

README.md

booru-api

Setup Instructions

  1. Rename the example environment file to .env:

    mv .example.env .env

  2. Start the application in detached mode:

    docker compose up -d

Default config/secrets.ts File

const e621Auth: Record<string, string> = {
  "User-Agent": "your-domain/1.0 (by your-username on e621)",
  Authorization: "Basic " + btoa("your-username:your-password"),
};

export { e621Auth };

Note

: Replace your-username and your-password with your e621 account credentials. Update the User-Agent string to include your domain and comply with e621's API guidelines.