Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
54 lines (40 loc) · 1.34 KB

CONTRIBUTING.md

File metadata and controls

54 lines (40 loc) · 1.34 KB

Contributing

About

Simple application built with a Next.js frontend and a FastAPI backend.

Frontend

Uses pnpm as the package manages and TailwindCSS and shadcn/ui to simplify styling.

Backend

Connects to an Orthanc image database and a HAPI FHIR server to store patient information.

Quick Start

1. Install necessary tools

Ensure pnpm and Docker are installed (install Docker Compose separately if you aren't using Docker Desktop). Instructions to install pnpm can be found here.

2. Set up dependencies

# Install dependencies
pnpm i

# Configure environment variables
cp .env.example .env

3. Set up backend and databases

# Enter backend directory
cd backend

# Run docker containers
docker compose up

You may need to rebuild if you have existing containers from an older compose config:

# Clean rebuild of containers
docker compose up --build

4. Start Next.js application

# Enter frontend directory
cd frontend

# Run app
pnpm dev

Usage

Backend

Once running, the FastAPI server should be accessible at 0.0.0.0:8000.