Local development
This guide will help you set up and run the Hanzo KMS platform in local development.
Fork and clone the repo
Fork the repository to your own GitHub account and then clone it to your local device.
Once, you've done that, create a new branch:
git checkout -b MY_BRANCH_NAMESet up environment variables
Start by creating a .env file at the root of the Hanzo KMS directory then copy the contents of the file linked here. View all available environment variables and guidance for each.
Starting Hanzo KMS for development
We use Docker to spin up all required services for Hanzo KMS in local development. If you are unfamiliar with Docker, don’t worry, all you have to do is install Docker for your machine and run the command below to start up the development server.
Start local server
docker compose -f docker-compose.dev.yml up --build --force-recreateAccess local server
Once all the services have spun up, browse to http://localhost:8080.
Shutdown local server
# To stop environment use Control+C (on Mac) CTRL+C (on Win) or
docker compose -f docker-compose.dev.yml downStarting Hanzo KMS docs locally
We use Mintlify for our docs.
Install Mint CLI.
npm i -g mintor
yarn global add mintRunning the docs
Go to docs directory and run mint dev. This will start up the docs on localhost:3000
# From the root directory
cd docs; mint dev;How is this guide?
Last updated on