README.md

Talos

• Talos
  • Overview
  • Getting Started
    • Requirements
    • Installation and setup.
    • Rust Scripts
    • Committing Code
  • IDE's
    • VSCODE Settings
  • Usage
    • Cohort Reference Implementation
  • Release Process
  • Release Notes

Overview

Talos is based on the STRIDE algorithm for strict serializable certification of distributed transactions

Getting Started

Requirements

• docker (20.10.6)
• cargo (1.75.0), rust (1.75.0) only required if wanting to run outside of docker
• openssl for SASL supports

Installation and setup.

OSX First install homebrew https://brew.sh/. Install coreutils package.

brew install coreutils
brew install openssl

To setup local development run the following.

make withenv RECIPE=dev.init

Rust Scripts

To compile code:

make withenv RECIPE=build

To run the unit tests:

make withenv RECIPE=test

To run the unit tests with code coverage:

make withenv RECIPE=test.unit.coverage.rust

To check and fix the linting of your code there are the following commands (it's a good idea to do this before attempting your commit)

make withenv RECIPE=lint

Committing Code

This repo enforces conventional commits. Once you have checked, tested and linted your code you may create a commit.

IDE's

VSCODE Settings

{
    "editor.formatOnSave": false,
    "editor.trimAutoWhitespace": true,
    "files.trimTrailingWhitespace": true
}

Usage

Cohort Reference Implementation

Release Process

The release process is explained in detail here

Release Notes