README.md

correspondence

A dead simple interface to send SMS messages built with FastAPI and SQLAlchemy.

Requirements

You must install:

• Python 3
• Postgresql
• Redis

On macOS, install homebrew

brew install python3 postgresql redis

Installation

Install uv first, then run:

uv sync

to install dependencies.

Install database

To install the database, run:

make flush

it will install the database and its schema.

Install frontend dependencies

npm install

Basic commands

API server

make run-api

Worker

make run-worker

Frontend

npm run watch