- Node.js v22+ (https://nodejs.org)
- pnpm (
corepack enable+corepack prepare pnpm@latest --activate)
- Rename the
.env.examplefile to.envand open it using any text editor. - Paste a live Firestorm database URL after
FIRESTORM_URL=in the newly-created.envfile:
- 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_TOKENif 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.
- If you're authenticating with the Faithful Studio, follow its project README for further instructions.
From there, install the project dependencies by running:
pnpm installTo start the API, run:
pnpm devpnpm buildYou can preview the production build with pnpm start.
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.