Vx Template App

Software Requirements

• Install Rust. Using Rustup Run the following in your terminal, then follow the onscreen instructions:

curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh

• Install trunk and wasm-bindgen-cli

cargo install --locked trunk
cargo install wasm-bindgen-cli

• Install Docker

• Install Docker-Compose

• Install Hasura CLI

$ curl -L https://github.com/hasura/graphql-engine/raw/stable/cli/get.sh | VERSION=v2.0.8 bash

or the one that is being used in the docker-compose file. You can also update by running

$ hasura update-cli --version v2.0.8

Developer Setup

1. Clone the project

$ git clone [email protected]:VertexStudio/vx-template-app

2. Copy the environment file as .env

$ cp .env.example .env

3. Run the development environment with docker-compose

$ docker-compose -f docker-compose.dev.yaml up -d

4. Update schema.graphql

# Uncomment in the update_schema.sh
#source '.env'
# Make the update_schema.sh executable
chmod +x update_schema.sh
# Run it
./update_schema.sh

5. Serve the Rust app with trunk

trunk serve

Run the Dockerfile of the Rust app

• Run the production environment with docker-compose instead of the development environment (Replaces Step 3)

$ docker-compose up -d

Services

Docker settings

After creating the services containers using Docker Compose: In order to make the Keycloak data persistent in the assigned volume for the Postgres service, you need to stop the containers, set the command in the Docker-compose file, then start the containers again.

'-Dkeycloak.migration.strategy=IGNORE_EXISTING'

Environment configuration

• Default environment file: .env
• Example environment file: .env.example