Getting Started

How to get started with Morphik Core

1

Clone Repository

Run `git clone https://github.com/morphik-org/morphik-core.git` and `cd morphik-core`. Ensure Docker, Docker Compose, at least 10GB disk space, and 8GB+ RAM are available.

2

Initial Setup

Run `docker compose up --build` to download models, initialize PostgreSQL/pgvector, and start services. This process takes approximately 5-10 minutes.

3

Access API

Access the API documentation at http://localhost:8000/docs or check server health at http://localhost:8000/health.

4

Run Web UI

Ensure the server is running, install npm, navigate to the `ui-component` directory, run `npm run dev`, then access the UI at http://localhost:3000.

5

Subsequent Runs

Start the server with `docker compose up` and stop it with `docker compose down`.