Hermod API

A platform for instant and seamless customer interaction.


docs.rs docs

Running API

Dependencies

Installation Instructions for Mac/Linux

```bash cd api

Install Rust, psql, and Docker

brew install rustup postgres # Install Rustup and psql command line tool brew cask install docker # Install Docker

Build and run application

./scripts/initdb.sh # Starts and migrates a Postgres database using Docker ./scripts/initcollector.sh # Starts an Open Telemetry collector using Docker cargo +nightly run # Compiles and runs the Hermod project using an edge Rust build (aka cargo r)

```

Rust project documentation

To view the project's auto-generated documentation, run cargo doc --open locally, or view the latest version online.

Useful commands

```bash

Install optional Rust command-line utilities

cargo install sqlx-cli # (Optionally) Install sqlx CLI cargo install bunyan # (Optionally) install Bunyan log formatter

Other useful commands

cargo doc --open # Compiles and opens project documentation (aka cargo d) cargo test # Runs unit and integration tests (aka cargo t)

cargo r | bunyan # Compiles and runs the project, piping log output to the Bunyan formatter TEST_LOG=true cargo t | bunyan # Runs tests with logging, piping output to Bunyan

./scripts/stop_db.sh # Stops the PostgresDB Docker container

sqlx mig add YOURMIGRATIONNAME # Create a new sqlx migration sqlx mig run # Run your new migration cargo sqlx prepare -- -lib # Rebuild sqlx's cache used for compile-time SQL guarantees cargo sqlx prepare --check -- --lib

docker build -t hermodapi . # Build the release image of the application (will take a *very* long time, Rust has infamously long release compilation times) docker run -p 8000:8000 hermodapi # Run the release image of the application

cloc configuration src tests migrations scripts ```

Project Architecture