Frequently Asked Questions

What are the credentials for local development?

host: https://local.kualibuild.com/app/builder
username: kualiadmin
password: admin

Where can I see emails when developing locally?

I often need to restart services when booting up. Any tips?

Yeah, it's bogus. For now you can add the following to your .zshrc/.bashrc/.bash_profile. Then just run build_restart_api after you build up and everything should run smoothly.

function docker-restart () {
  docker container restart $(docker ps | grep $1 | awk '{print $1}')
}

alias build_restart_api='
  docker-restart workflows-api;
  docker-restart forms-api;
  docker-restart builder-api;
  docker-restart identity;
'

Is there a quick way to tail the logs of a local service?

I'm glad you asked! Add the following snippet to your .zshrc/.bashrc/.bash_profile and then run something like docker-logs builder-api. It filters the names of your running docker containers and displays logs if it gets one and only one match. So you can shorten it in some cases and do, for example, docker-logs flow to get the logs for workflows-api.

function docker-logs () {
    docker logs -f $(docker ps | grep $1 | awk '{print $1}')
}

How can I develop on another service alongside builder-ui?

Great question! Any one of our services can be developed on by itself by pulling down the service code and running build up. This will find the build.service.json5 file within that project and set everything up based on it.

To develop on more than one service, you'll need to create a file called build.services.json5 (note the plural "services" in the name) and add something like the following to it:

{
  run: [
    '../builder-ui',
    '../platform-api/packages/builder-api-node',
    '../platform-api/packages/forms-api',
    '../platform-api/packages/workflows-api'
  ]
}

Running build up in the same directory as that file will run builder-ui and all of the base platform services locally so you can develop on them. It will also pull down and run all the dependencies needed to run these services. Each path in the run array needs to point to a directory containing a build.service.json5 file (which each of our services has).

The full set of docs for the build cli can be found at: https://github.com/kualibuild/build-cli

How does builder-ui fit into the bigger picture?

Check out https://kuali.slite.com/app/channels/NHqDBHGF7m/notes/OWvG8GzRWY for more info on that.