Getting Started
This section gets a new local PhenoWorks web-platform checkout to the first usable study workspace.
Quick Path
- Install the backend package and frontend dependencies.
- Configure database, data directory, and branding values.
- Start the FastAPI backend and Next.js frontend.
- Sign in with the default local administrator account.
- Create a project, study, dataset, plot, and asset.
- Run the first analysis pipeline.
Requirements
| Area | Requirement |
|---|---|
| Python | Python 3.11 or newer. |
| Backend | FastAPI, SQLAlchemy, Pydantic, LgoPy, lgopy-catalog, Celery/RabbitMQ support, and storage dependencies from pyproject.toml. The backend runs locally today and is intended to move to cloud infrastructure later. |
| Frontend | Node.js and the package manager used by the ui/ workspace. |
| Database | PostgreSQL through PHENOWORKS_DB_* settings, or an explicit PostgreSQL PHENOWORKS_DATABASE_URL. |
| Storage | A writable PHENOWORKS_DATA_DIR for uploads, assets, artifacts, analysis modules, and logs. |
Launch Commands
Both Servers
make run-dev
# or: just run-dev
Backend
make dev-api
# or: just dev-api
Frontend
make dev-ui
# or: just dev-ui
Default Login
| User | Password | |
|---|---|---|
| Administrator | admin@phenoworks.local | phenoworks-admin |
| Collaborator demo user | collaborator@phenoworks.local | phenoworks-collab |
warning
Replace default credentials and secrets before exposing the app outside a local development environment. Keep AUTH_SECRET or NEXTAUTH_SECRET stable inside one environment so browser sessions remain valid.
Next Steps
- Install the application: Docker Compose deployment
- Configure runtime settings: Configuration
- Create a study workspace: First Project