leteranne is a social media app that lets people send intentionally delayed messages ("letters"). Invite friends or make new ones and immerse yourself in deep conversations.
Below you can find links to the documentation of major projects used in this application.
- Python 3.12
- Django 5.0
- Django REST Framework
- PostgreSQL 16.2
- Node.js 21.7
- React 18
- Mantine
- Docker
- DevContainers
- MkDocs
Optional dependencies:
- Recommended: Install just to run project tasks (optional, but recommended; if you don't install it you have to copy-paste commands from justfile to follow the rest of this section)
- Install mise to manage versions of Node.js and Python
- Install EditorConfig to keep coding style consistent
Clone the repo with git:
# by using https...
git clone https://github.com/kstypik/letteranne.git
# ... OR by using SSH
git clone [email protected]:kstypik/letteranne.gitMove to directory:
cd letteranneWith just installed, you can run the command below to set the local environment variables, install Python & Node on your machine through mise and build Docker images:
just setupIt might be useful to create a Python virtual environment on your local machine with all the project's dependencies so they can be used by your IDE:
uv venv
# On macOS and Linux...
source .venv/bin/activate
# ... OR on Windows.
.venv\Scripts\activate
uv pip install --requirement letteranne/requirements.txtAfter the setup, you can start the containers by simply typing:
just up --detachedIf everything went smoothly, your local application should be up and running under localhost:8000
TBD
The name came to my mind while reading L. M. Montgomery's book Anne of Windy Poplars which largely consists of letters Anne wrote to her fiancé Gilbert.