This project builds the frontend for the stash-box server. It can be used to build the static bundle for the go server, or be run standalone for development purposes.

Setup / Installing

Make sure your environment is up to date:

node >= 22
pnpm >= 9

For node installation instructions, please see the websites for node.js.

PNPM can usually be installed by running corepack enable pnpm. For other options, see the PNPM website.

Install dependencies

pnpm i

GraphQL development

If any queries/mutations or the schema on the server is updated, the Typescript types can be updated with:

pnpm generate

Running

Local development server

The API key can be set in the environment configuration. To do so, you will need to initialize the environment configuration:

cp .env.development.local.shadow .env.development.local

Fill in the VITE_APIKEY variable in .env.development.local with the API key for the user.

Run the local development server:

pnpm start

The server will by default start on http://localhost:3001 and will automatically be updated whenever any changes are made. The port can be changed by uncommenting the PORT entry and setting the value in the .env.development.local file.

Run the linter:

pnpm lint

Run the code formatter:

pnpm format

Build the release bundle:

pnpm build

Run the validation (before submitting a Pull Request)

pnpm validate