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.
28 commits 2 branches 0 tags 128 KiB
Find a file
creations e6acb47796
add tag_format option
2025-04-03 15:16:13 -04:00
.vscode first commit 2024-12-28 09:13:34 -05:00
config disable realb, api is disabled since they suck at coding 2025-03-08 00:52:11 -05:00
src add tag_format option 2025-04-03 15:16:13 -04: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
.env.example change the name for the example env 2025-01-08 09:00:43 -05:00
.gitattributes first commit 2024-12-28 09:13:34 -05:00
.gitignore move e621 auth to .env, edit readme 2025-01-05 21:46:01 -05:00
compose.yml add docker support, move to env file, add example 2025-01-05 20:48:29 -05:00
Dockerfile update dockerfile 2025-01-05 21:02:28 -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-02-06 11:50:26 -05:00
tsconfig.json first commit 2024-12-28 09:13:34 -05:00

README.md

booru-api

Setup Instructions

Production Environment

  1. Clone the repository:

    git clone https://git.creations.works/creations/booru-api
cd booru-api

  2. Copy the example environment file to .env:

    cp .env.example .env

  3. Start the application in detached mode:

    docker compose up -d

Development Environment

  1. Clone the repository:

    git clone https://git.creations.works/creations/booru-api
cd booru-api

  2. Copy the example environment file to .env:

    cp .env.example .env

  3. Install dependencies using Bun:

    bun install

  4. Start the development server:

    bun dev

Note

To use the e621 API, you must update the following environment variables in your .env file:

# REQUIRED if you want to use the e621 API
E621_USER_AGENT=YourApplicationName/1.0 (by username on e621)
E621_USERNAME=your-username
E621_API_KEY=your-apikey

Replace your-username and your-apikey with your e621 account credentials. Update the User-Agent string to include your application name, version, and a contact method (e.g., your e621 username) to comply with e621's API guidelines.