Skip to content
Paperwise
GitHub

Dev Environment Setup

CommandPurpose
make setupCreate the local virtualenv and install dependencies
make setup PYTHON=python3.13Use Python 3.13 explicitly
make deps-upStart local dependency services (redis and postgres)
make deps-downStop local dependency services
make dev-upStart dependencies, backend, and worker in the background
make dev-stopStop the backend and worker started by make dev-up
make dev-restartRestart the local development stack
make dev-statusShow backend, worker, and dependency status
make backendRun the FastAPI backend from the local virtualenv
make workerRun the Celery worker from the local virtualenv
make testRun tests
  • App UI: http://localhost:8000
  • Postgres: localhost:5432
  • Redis: localhost:6379

By default, local config uses in-memory storage. To persist data in Postgres, set:

Terminal window
PAPERWISE_REPOSITORY_BACKEND=postgres
PAPERWISE_POSTGRES_URL=postgresql+psycopg://paperwise:paperwise@localhost:5432/paperwise

Then run make deps-up and restart the backend.