> For the complete documentation index, see [llms.txt](https://documentation.opencrvs.org/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://documentation.opencrvs.org/technical/guides/installation/local-development/quick-start.md).

# Quick Start

Before you start, install the required tools and start a local Kubernetes cluster, see [Prerequisites](/technical/guides/installation/local-development/prerequisites.md).

### Create a country configuration

{% tabs %}
{% tab title="Run with Node" %}

```bash
npm create @opencrvs/countryconfig@latest <project-name>
```

{% endtab %}

{% tab title="Run with docker" %}
If you don't have Node.js installed, run the same command with Docker. Modify `<project-name>` before running:

```bash
docker run --rm -it \
  -v "$PWD":/work -w /work \
  --user "$(id -u):$(id -g)" -e HOME=/tmp \
  node:22 npx --yes @opencrvs/create-countryconfig@latest <project-name>
```

`--user` makes the created files belong to you instead of `root`.
{% endtab %}
{% endtabs %}

This command creates two directories: `<project-name>-countryconfig`, a country configuration package with a minimal example configuration, and `<project-name>-infrastructure`, for deploying to servers. It asks for your organisation name and country code first.

### Run local development environment

Go to your country configuration directory:

```bash
cd <path>/<project-name>-countryconfig
```

Start the development environment:

```bash
tilt up
```

Open the Tilt UI at <http://localhost:10350>.

Wait until all resources in the `1.OpenCRVS` group are green. The first `tilt up` downloads all OpenCRVS Core images, so it can take a long time, depending on your internet connection. Later starts are much faster. Follow the progress in each resource's logs.

Then run the data seed task from the Tilt UI:

1. Open <http://localhost:10350>
2. Find the `2.Data-tasks` section
3. Run the `data-seed` or `clean-&-seed` resource
4. Wait until the job completes

### Log in

Open OpenCRVS at <http://opencrvs.localhost> and log in with a test user, for example username `k.mweene` and password `test`. If you are asked for an authentication code, use `000000`.

For all test users, see [Log in to OpenCRVS locally](/technical/guides/installation/local-development/log-in-to-opencrvs-locally.md).

That's it! 🎉

### Next steps

Read [Working with Tilt](/technical/guides/installation/local-development/working-with-tilt.md) to learn how to use the Tilt UI, reload your changes, reset data and access OpenCRVS services.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://documentation.opencrvs.org/technical/guides/installation/local-development/quick-start.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.