Creating an application

Generate the application

The best way to create a new Blacksmith application is by using the generate command of the CLI. The following command generates all the required files in the current directory:

$ blacksmith generate application \
  --name myapp

If you prefer, you can generate a new application inside a directory with the --path flag:

$ blacksmith generate application \
  --name myapp \
  --path ./myapp

The directory will be created if it does not exist yet.

Docker stack for development

A Docker-compose.yml is generated along your application. This file is not required for running the application but is here for convenience to help you get started faster in development. It includes:

  • A PostgreSQL database for the Blacksmith store (persistence).
  • A PostgreSQL database for the Blacksmith visibility (search).
  • A PostgreSQL database used as a simple warehouse across the guides.
  • The Temporal UI for exploring your Blacksmith application.

You can customize the stack as much as you need, and then run it with:

$ docker compose up -d

It initializes the Blacksmith store and visibility databases when running for the first time so you don't need to worry about anything in a development environment.

Is something missing?

If you notice something we've missed or could be improved on, please follow this link and submit a pull request to the repository. Once we merge it, the changes will be reflected on the website the next time it is deployed.

Thank you for your contributions!