Docs
chromia.com

Build and run

On this page

In this topic, you'll build and deploy the Hello World dapp with the Chromia Command-line Interface (Chromia CLI). Read more about the features of the Chromia CLI in the Chromia CLI command reference section.

Prerequisites

Run dapp in Chromia CLI

Once you install the Chromia CLI, it's time to create a project.

  1. Create the project folder in a path of your choice and use the chr create-rell-dapp command.

    Terminal
    chr create-rell-dapp

    The chr create-rell-dapp command creates a new Rell structured project my-rell-dapp with the necessary files. A main.rell file, which includes the Hello World query and test files in the src/test/ folder. You also have a standard configuration for your project in the chromia.yml file. For more information, see the project config file.

    Files
    my-rell-dapp
       |--chromia.yml
       |--src
          |--main.rell
          |--test
             |--arithmetic_test.rell
             |--data_test.rell

    The next step is to start a node and run your app locally. You can do it in a couple of different ways, but the most straightforward method we recommend is the Chromia CLI.

  2. Start the node using the chr node start command inside the newly created project directory:

    Terminal
    cd my-rell-dapp
    chr node start

    The chr node start command starts a node with your applications running on it. All the blockchains listed in the blockchains key in the chromia.yml file get started.

    YAML
    blockchains:
      my_rell_dapp: <----- This is the blockchain that starts
        module: main <----- This is the entry point of the chain

    The node should now be running with a local blockchain. The terminal where you ran chr node start will display info messages about committed blocks and transactions. Any print statements in your Rell code will also appear there.

    The last step is to query your dapp and test that the backend works correctly.

  3. Write the following in a new terminal with your project folder as the working directory.

    Terminal
    chr query hello_world
  4. Your terminal should show you the following message.

    Output
    "Hello World!"

    Great! You've successfully queried your dapp. Queries are read-only operations that retrieve data from the blockchain.

  5. Now let's modify the data by running a transaction. Transactions (also called operations) can change the state of your dapp.

    First, generate a key pair to sign your transactions:

    Terminal
    chr keygen --key-id=chromia_key

    This creates a key pair in the .chromia folder in your home directory (chromia_key, chromia_key.pubkey and chromia_key_mnemonic) that will be used to sign transactions.

  6. Run a transaction to change the name from "World" to "Developer":

    Terminal
    chr tx set_name "Developer"
  7. Query again to see the change:

    Terminal
    chr query hello_world

    Your terminal should now show:

    Output
    "Hello Developer!"

Great job! The Rell backend is up and running and works as it should. You've learned how to:

  • Query data from your dapp (read)
  • Run transactions to modify data (write)
  • Verify changes by querying again

You have now run a complete Hello World dapp in the Chromia CLI.

Run dapp in VS Code

The extension enables language features for Rell, including syntax highlighting and compilation warnings. It contributes the commands Rell: New Template Project and Rell: Invalidate index caches, which are available in the Command Palette. Once you install the extension, it's time to create a project.

  1. Open the Command Palette by going to the menu View - Command Palette. Type Rell: New Template Project.

    project template
  2. The command Rell: New Template Project asks you to select the project type from the dropdown menu. Select Minimal.

    project template selection minimal
  3. Next, you get my-rell-dapp as prefilled project name. Press Enter to create the project.

    project name

    It creates a new Rell structured project with the necessary files. A main.rell file, which includes the Hello World query and test files in the src/test/ folder. You also have a standard configuration for your project in the chromia.yml file. For more information, see the project config file.

    project folder
  4. Use the Node start command to start the node.

    node start

    Locate the Blockchain RID in the terminal output. You need it to interact with your dapp. The Blockchain RID is the hex value following the Blockchain RID: tag. For example, see the following image.

    blockchain RID VS

    The last step is to query your dapp and test that the backend is working correctly.

Run the following command to call the hello_world query defined in main.rell:

Terminal
chr query hello_world

You should see:

Output
"Hello World!"

Great! You've successfully queried your dapp. Queries are read-only operations that retrieve data from the blockchain.

Run a transaction

Now let's modify the data by running a transaction. Transactions (also called operations) can change the state of your dapp.

  1. First, generate a key pair to sign your transactions. Run this command in the terminal:

    Terminal
    chr keygen --key-id=chromia_key

    This creates a key pair in the .chromia folder in your home directory (chromia_key, chromia_key.pubkey and chromia_key_mnemonic) that will be used to sign transactions.

  2. Run a transaction to change the name from "World" to "Developer":

    Terminal
    chr tx set_name "Developer"
  3. Query again to see the change:

    Terminal
    chr query hello_world

    You should now see:

    Output
    "Hello Developer!"

Great job! The Rell backend is up and running and works as it should. You've learned how to:

  • Query data from your dapp (read)
  • Run transactions to modify data (write)
  • Verify changes by querying again

You have now run a complete Hello World dapp in VS Code.

Optional Next steps

Now that your Rell backend is running, you can: