Skip to main content

Setup local development

The one-core handles the complete lifecycle of credentials and is available with an open source license. This page shows you how to get it deployed for local development and testing.

Prerequisites

  • Rust 1.88+ - Install via rustup.rs
  • Docker with Docker Compose - Docker Desktop recommended for easiest setup
  • Install cargo-make: cargo install cargo-make

Quick start

  1. Verify Docker is running.

docker compose version
  1. Compile the project.

makers build
  1. Start the database.

makers dbstart
  1. Start the server.

makers run
  1. Open http://localhost:3000/swagger-ui/index.html
    You should see the Swagger UI interface

  2. Click the "Authorize" button and set the authorization bearer token: test
    You can now make API calls directly to the server using the Swagger UI interface

What's running:

Troubleshooting

  • Issues compiling - check rustc --version and run rustup update if your version is before 1.88.
  • Issues starting the database - make sure Docker is running.
    • Mac: you should see the whale icon in your menu bar.
    • Windows: you should see the whale icon in your system tray.
  • Issues making API calls - make sure you have added the authorization bearer token test to the swagger.
    • If you still have issues with calls, check the value of app.authToken in config/config-local.yml as this determines your authorization token.

What's next