PrintStash

https://github.com/xiao-villamor/printstash
Admin
PrintStash is an open-source, self-hosted web application for organizing 3D models, managing sliced...
Tokens:293,360
Snippets:2,273
Trust Score:7
License:AGPL-3.0
Update:3 weeks ago
Show doc for...
Tokens:
Raw
### Frontend setup and dev server

Source: https://github.com/xiao-villamor/printstash/wiki/Development

Installs frontend dependencies and starts the development server.

```bash
cd frontend
pnpm install
pnpm dev
```

--------------------------------

### Backend setup and run

Source: https://github.com/xiao-villamor/printstash/wiki/Development

Sets up the backend development environment and starts the FastAPI server with hot reload.

```bash
cd backend
uv sync --extra dev
uv run uvicorn app.main:app --reload
```

--------------------------------

### Setup Backend Development Environment

Source: https://github.com/xiao-villamor/printstash/blob/main/CONTRIBUTING.md

Commands to synchronize dependencies and start the backend development server with a local data root.

```bash
cd backend
uv sync --extra dev

VAULT_DATA_ROOT=./_data uv run uvicorn app.main:app --reload
```

--------------------------------

### Start the manual-test stack with docker compose

Source: https://github.com/xiao-villamor/printstash/blob/main/docs/manual-testing.md

Copies the example environment file and starts the manual-testing stack with the identity and emulators profiles. Requires the copied env file to be present and the identity profile to be selected for OIDC to be enabled.

```bash
cp deploy/manual-testing/.env.example deploy/manual-testing/.env
docker compose \
  --env-file deploy/manual-testing/.env \
  -f deploy/manual-testing/compose.yml \
  --profile identity --profile emulators \
  up -d --build --wait
```

--------------------------------

### Quick start: install dependencies and run uvicorn

Source: https://github.com/xiao-villamor/printstash/blob/main/backend/README.md

Sets up the development environment and starts the FastAPI server with hot reload. The VAULT_DATA_ROOT environment variable controls where app data, including SQLite, is stored.

```bash
cd backend

# First time — create venv and install deps
uv sync --extra dev

# Run the server; every app path, SQLite included, lives under ./_data
VAULT_DATA_ROOT=./_data uv run uvicorn app.main:app --reload
```

--------------------------------

### Start advanced deployment with docker compose

Source: https://github.com/xiao-villamor/printstash/blob/main/docs/deployment.md

Starts the advanced reference deployment. The first command runs the core stack; the second adds optional PostgreSQL and SeaweedFS (S3) services via profiles. Include -f docker-compose.advanced.yml in every later Compose command, or save it as docker-compose.yml in its own install directory. To build from a checkout, uncomment the two build: blocks and add --build.

```bash
docker compose -f docker-compose.advanced.yml up -d
# Optional services, internal-only:
docker compose -f docker-compose.advanced.yml --profile postgres --profile s3 up -d
```

--------------------------------

### Clean Install Commands

Source: https://github.com/xiao-villamor/printstash/blob/main/docs/release-validation.md

Run these commands to validate a clean install. Copies the environment template, starts the stack in detached mode, and verifies the health endpoint. Expected results include the setup page at /setup and the health API returning the current app version.

```bash
cp .env.example .env
docker compose up -d --build
curl -fsS http://localhost:8000/api/v1/health
```

--------------------------------

### Download and start PrintStash with Docker Compose

Source: https://github.com/xiao-villamor/printstash/blob/main/README.md

Use this command sequence to create a directory, download the docker-compose.yml file, and start the PrintStash container. Run it in a terminal with Docker and the Compose plugin installed.

```bash
mkdir -p printstash && cd printstash
curl -fsSL https://raw.githubusercontent.com/xiao-villamor/PrintStash/main/docker-compose.yml -o docker-compose.yml
docker compose up -d
```
Tokens:
Raw