Skip to content

nadeemb53/letter-rs

Repository files navigation

Newsletter backend

example workflow

Health check: production

Pre-requisites

You'll need to install:

There are also some OS-specific requirements.

Windows

cargo install -f cargo-binutils
rustup component add llvm-tools-preview
cargo install --version=0.6.0 sqlx-cli --no-default-features --features postgres

Linux

# Ubuntu 
sudo apt-get install lld clang libssl-dev postgresql-client
# Arch 
sudo pacman -S lld clang postgresql
cargo install --version=0.6.0 sqlx-cli --no-default-features --features postgres

MacOS

brew install michaeleisel/zld/zld
cargo install --version=0.6.0 sqlx-cli --no-default-features --features postgres

How to build

Launch a (migrated) Postgres database via Docker:

./scripts/init_db.sh

Launch a Redis instance via Docker:

./scripts/init_redis.sh

Launch cargo:

cargo build

You can now try with opening a browser on http://127.0.0.1:8000/login after having launch the web server with cargo run.

There is a default admin account with password everythinghastostartsomewhere. The available entrypoints are listed in src/startup.rs

How to test

Launch a (migrated) Postgres database via Docker:

./scripts/init_db.sh

Launch cargo:

cargo test