02 / 27Beginner
Project setup complete
Make sure the following are set up before you begin:
PostgreSQL database setup
Set up PostgreSQL database
Rell needs PostgreSQL 16.3. Without a database, the IDE still works but cannot run a node. You don't need a database to run a console or a remote postchain app.
Rell expects these database settings by default:
- database:
postchain - user:
postchain - password:
postchain
Install
-
Install Homebrew by following the Homebrew installation guide.
-
Install PostgreSQL:
shell brew install postgresql@16brew services start postgresql@16createuser -s postgres -
Create and configure the database:
plsql psql -U postgres -c "CREATE DATABASE postchain WITH TEMPLATE = template0 LC_COLLATE = 'C.UTF-8' LC_CTYPE = 'C.UTF-8' ENCODING 'UTF-8';" -c "CREATE ROLE postchain LOGIN ENCRYPTED PASSWORD 'postchain'; GRANT ALL ON DATABASE postchain TO postchain;"
-
Install PostgreSQL:
bash sudo apt install postgresql-16 -
Create and configure the database:
bash sudo -u postgres psql -c "CREATE DATABASE postchain WITH TEMPLATE = template0 LC_COLLATE = 'C.UTF-8' LC_CTYPE = 'C.UTF-8' ENCODING 'UTF-8';" -c "CREATE ROLE postchain LOGIN ENCRYPTED PASSWORD 'postchain'; GRANT ALL ON DATABASE postchain TO postchain;"
-
Install Docker by following the Docker installation guide.
-
Create and configure the database:
dockerfile docker run --name postgres -e POSTGRES_USER=postchain -e POSTGRES_PASSWORD=postchain -p 5432:5432 -d postgres:16.3-alpine3.20
-
Get the PostgreSQL installer from the PostgreSQL download page.
-
Run the installer, then add the PostgreSQL folder that holds the binaries to your environment variables. In the Command Prompt (CMD), run the command below. Check that the path points to your binaries and substitute the real version number for the
<version>placeholder:shell setx POSTGRESQL "C:\Program Files\PostgreSQL\<version>\bin" -
Close and reopen the Command Prompt (CMD) so the new environment variables take effect. Then run these two commands, one after the other, to create and configure the database:
plsql psql -U postgres -c "CREATE DATABASE postchain WITH TEMPLATE = template0 LC_COLLATE = 'en_US.UTF-8' LC_CTYPE = 'en_US.UTF-8' ENCODING 'UTF-8';"psql -U postgres -c "CREATE ROLE postchain LOGIN ENCRYPTED PASSWORD 'postchain'; GRANT ALL ON DATABASE postchain TO postchain;"
Install Chromia CLI
Install Chromia CLI
Follow these steps to install and update the Chromia CLI.
Prerequisite
You need the following before you start:
- PostgreSQL database: Follow Set up PostgreSQL database.
- RELL_JAVA environment: Chromia CLI runs on a Java runtime, version 21 or later. The package managers handle this dependency for you, so no manual setup is needed. To choose a specific Java runtime for Chromia CLI, set the RELL_JAVA environment variable to the path of a valid Java installation.
Installation
Install Chromia CLI through a package manager, or download it directly from Chromia CLI Packages.
On macOS, install Chromia CLI (chr) as follows:
-
Install Homebrew if you don't already have it:
bash /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)" -
Register the Chromia repository with Homebrew:
bash brew tap chromia/core https://gitlab.com/chromaway/core-tools/homebrew-chromia.git -
Install Chromia CLI:
bash brew install chromia/core/chr -
Confirm the installation by printing the version:
bash chr --version
On Linux or WSL (Windows Subsystem for Linux), install Chromia CLI (chr) as follows:
-
Fetch Chromia's
apt-repopublic key and add it to your trusted keyrings:bash curl -fsSL https://apt.chromia.com/chromia.gpg | sudo tee /usr/share/keyrings/chromia.gpg -
Add the Chromia repository to your package sources:
bash echo "deb [arch=amd64 signed-by=/usr/share/keyrings/chromia.gpg] https://apt.chromia.com stable main" | sudo tee /etc/apt/sources.list.d/chromia.list -
Refresh your package sources:
bash sudo apt-get update -
After the update completes, install Chromia CLI:
bash sudo apt-get install chr -
Confirm the installation by printing the version:
bash chr --version
On Windows, install Chromia CLI (chr) with Scoop as follows:
-
Install Scoop if you don't already have it. Run this in PowerShell as Administrator:
powershell iwr -useb get.scoop.sh | iex -
Add the Chromia bucket to Scoop:
powershell scoop bucket add chromia https://gitlab.com/chromaway/core-tools/scoop-chromia/ -
Add the Java bucket to Scoop:
powershell scoop bucket add javaScoop needs this bucket to fetch openjdk21, which chromia-cli depends on during installation.
-
Install Chromia CLI:
powershell scoop install chr -
Confirm the installation by printing the version:
powershell chr --version
Updating Chromia CLI
Get the newest Chromia CLI from the package registry. If you installed it with a package manager, update it with the matching command:
brew updatebrew upgrade chrsudo apt-get updatesudo apt-get install chrscoop updatescoop update chrDocker
You can use Docker to run a standalone Linux container that already includes the Chromia CLI. Set up the PostgreSQL database first.
The published images require Docker to be installed and configured on your host. For Windows, Mac, and Linux instructions, see install Docker in the Docker documentation.
Start the Docker container with Chromia CLI pre-installed
To run the latest Chromia CLI, pass the CLI image name and chr to docker run:
docker run --rm -v $(pwd):/usr/app registry.gitlab.com/chromaway/core-tools/chromia-cli/chr:<latest version> chrTo update or remove the Docker image, consult the Docker command line reference.
#!/bin/bash# Allocate a pseudo-TTY one when run in interactive modeif [ -t 0 ] && [ -t 1 ] ; then TTY="--tty"; else TTY=""; fidocker run \ # Sets the network to host to not need to change the database hostname (linux only) --network=host \ # Set timezone based on system settings (linux only) -e TZ=$(cat /etc/timezone) \ # Sets process ownership to current user --user $(id -u):$(id -g) \ --mount type=bind,source="/etc/passwd",target=/etc/passwd,readonly \ --mount type=bind,source="/etc/group",target=/etc/group,readonly \ # Configures ssh-agent (only needed if chr install is called on non-public repositores) -e SSH_AUTH_SOCK=$SSH_AUTH_SOCK \ --volume "$SSH_AUTH_SOCK:$SSH_AUTH_SOCK" \ --mount type=bind,source="${HOME}/.ssh",target=${HOME}/.ssh,readonly \ --mount type=bind,source="${HOME}/.config/jgit",target=${HOME}/.config/jgit \ # Mounts current folder into the container (Use `Get-Location` on PowerShell) --mount type=bind,source="$(pwd)",target=/usr/app \ --interactive ${TTY} \ --rm \ registry.gitlab.com/chromaway/core-tools/chromia-cli/chr:${CHR_VERSION:-latest} chr "$@"Clone the repository
Get a local copy of the course repository:
git clone git@bitbucket.org:chromawallet/news-course.gitNavigate to the project directory
Move into the project folder:
cd news-course/rellInstall dependencies
Install the project's dependencies:
chr install