Skip to content
Faithful-Resource-PackPublic

About

Public RESTful API for Faithful's texture database, add-on submission, and more.

Topics

Resources

Stars

1 star

Watchers

1 watching

Forks

Repository files navigation

Faithful Logo

Faithful API

Public RESTful API for Faithful's texture database, add-on submission, and more.

RepoSize Issues PullRequests

Status Uptime


Requirements

  • Node.js v22+ (https://nodejs.org)
  • pnpm (corepack enable + corepack prepare pnpm@latest --activate)

Running

  1. Rename the .env.example file to .env and open it using any text editor.
  2. Paste a live Firestorm database URL after FIRESTORM_URL= in the newly-created .env file:
  • There is a readonly test database available at https://database.faithfulpack.net/firestorm-test for public usage, which is updated every few months. You can ignore FIRESTORM_TOKEN if you only need read access, since it is only checked against privileged operations.
  • You can also host your own local Firestorm instance by following the instructions on its GitHub repository, if you do need to test write access.
  1. If you're authenticating with the Faithful Studio, follow its project README for further instructions.

From there, install the project dependencies by running:

pnpm install

To start the API, run:

pnpm dev

Building

pnpm build

You can preview the production build with pnpm start.

Database Reference

The Faithful API is based on the firestorm-db self-hosted database. Check out its documentation for more information about creating collections, available database operations, and working with files.

About

Public RESTful API for Faithful's texture database, add-on submission, and more.

Topics

Resources

Stars

1 star

Watchers

1 watching

Forks

Used by

Contributors

Languages