RadQuest

Development

Pre-requisites

• node >=18
• npm@9.6.7
• docker client

# Install dependencies in project root folder
npm install

Run frontend only

npm run dev:dapp

Run the full-stack

# starts all services
docker compose up

# creates the required tables and schemas in database
# only needed if there are changes in the schema or in a newly cloned repo
npm run db:push

# builds commonjs version of database client
npm run db:build

# runs all applications in development mode
npm run dev

Install dependency

# run in project root folder
npm install PACKAGE_NAME --workspace=NAME_OF_APP

Update dependency

# run in project root folder
npm update PACKAGE_NAME --workspace=NAME_OF_APP

Uninstall dependency

# run in project root folder
npm uninstall PACKAGE_NAME --workspace=NAME_OF_APP

User authentication

Deployment

See the Deployment Guide for local development setup and production deployment instructions.

Architecture

Folder structure

├── apps
    ├── dapp
    ├── notification
    ├── transaction-stream
    └── workers

dApp

Frontend and public API.

Notification

User notifications with real-time data.

Transaction steam

Ingests and filters through a live stream of transactions on the Radix network.

Workers

Processors of items in message queues.

Commit message

We are enforcing commits according to a slightly modified version of Conventional Commits

The commit message should be structured as follows:

<type>(<scope>): <description>

[optional body]

[optional footer(s)]

The commit contains the following structural elements, to communicate intent to fellow developers and readers of the changelog:

Types

• feat: introduces a new feature to the codebase (this correlates with MINOR in Semantic Versioning).
• fix: patches a bug in your codebase (this correlates with PATCH in Semantic Versioning).
• code: code logic addition that is not a feature.
• build: somehow related to building the applications.
• chore: updating dependencies or similar minor change.
• ci: changes related to CI/CD
• docs: changes to the documentation
• perf: improving performance
• refactor: refactor changes
• revert: reverting a commit
• style: changes to UI styling
• test: changes to unit tests and/or integration tests

Scopes

• dapp
• wallet
• notification
• stream
• workers
• db
• jetty-swap
• core - changes that affect the whole project