Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pablonicolla/nuntius
A local-first mobile messaging app. The goal is to not store messages in the server.
https://github.com/pablonicolla/nuntius
django docker expo python react-native terraform typescript
Last synced: 3 days ago
JSON representation
A local-first mobile messaging app. The goal is to not store messages in the server.
- Host: GitHub
- URL: https://github.com/pablonicolla/nuntius
- Owner: PabloNicolla
- License: mit
- Created: 2024-07-04T01:42:23.000Z (4 months ago)
- Default Branch: master
- Last Pushed: 2024-08-15T18:01:37.000Z (3 months ago)
- Last Synced: 2024-08-16T03:12:00.816Z (3 months ago)
- Topics: django, docker, expo, python, react-native, terraform, typescript
- Language: TypeScript
- Homepage:
- Size: 5.63 MB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# NUNTIUS
A local-first mobile messaging app. The goal is to not store messages in the server.
## Table of Contents
- [Tech Stack](#tech-stack)
- [Project Configuration (Run locally or Cloud deployment)](#project-configuration-run-locally-or-cloud-deployment)
- [Backend](#backend)
- [Allow Social Login (Optional)](#allow-social-login-optional)
- [Allow Images, Audio, Videos, and Files Upload (Optional)](#allow-images-audio-videos-and-files-upload-optional)
- [Alternative Backend (Run Django on Host Machine)](#alternative-backend-run-django-on-host-machine)
- [IAAS](#iaas)
- [Frontend](#frontend)
- [Features](#features)
- [Send/Receive Message Flow](#sendreceive-message-flow)
- [API Reference](#api-reference)
- [Authors](#authors)
## Tech Stack
**Client:** React Native, EXPO, SQLite3
**Server:** Python 3.12, Django, Redis, Postgres, Daphne
**IAAS:** Azure, AWS, (Terraform)
## Project Configuration (Run locally or Cloud deployment)
### Backend
---
[docker-compose.yaml](docker-compose.yaml) file already contains all the default variables for development set up.
you can modify as needed, for example if you already have containers or services running on the ports that are going to be used.
```
docker compose up --build
```
#### Allow social login (OPTIONAL)
---
> [!IMPORTANT]
> If you want to use Google Authentication, you will need to access django admin and create a new Social application.
first shutdown docker compose.
```
docker compose down
```
Modify [docker-compose.yaml](docker-compose.yaml) adding a new port forwarding between web (django) container and your host machine.
For example:
```yaml
ports:
- "8000:8000"
- "8899:8899" # try one that is available both on the container and on host: :
```
run docker compose again.
```
docker compose up --build
```
```sh
# access django container
docker-compose exec web bash # web is the django container name
# create superuser
python manage.py createsuperuser
# run django with runserver using the correct port
python manage.py runserver 0.0.0.0:8899
```
On host machine access `http://localhost:8899/admin` and add Social applications
after that you can close the runserver, run compose down, and rebuild again without the additional port forwarding
> [!NOTE]
> For more experienced users, the above may be achieved using `manage.py shell` and creating the object
#### Allow images, audio, videos and files upload (OPTIONAL)
---
To support these features you will need to follow the `#Support for file upload` at [Terraform](terraform/README.md) Readme file
#### Alternative Backend (Run Django on host machine)
---
> [!NOTE]
> This steps only apply if you don't want to run Django on a container
- run only Postgres and Redis containers.
- open [Backend](backend/README.md) and follow steps
### IAAS
---
Deploy backend infrastructure using Azure & AWS with Terraform script.
Follow instructions at [Terraform](terraform/README.md)
### Frontend
---
Open [Frontend](frontend/nuntius/README.md) instructions for building the Expo app.
## Features
### Send/Receive text message flow
```mermaid
sequenceDiagram
title Send/Receive message
participant SenderDB as SenderDB
participant Sender as Sender
participant Django as Django
participant DjangoDB as DjangoDB
participant DjangoRedis as DjangoRedis
participant Receiver as Receiver
participant ReceiverDB as ReceiverDB
Sender->>Django: wss(msg)
Django->>Sender: status(msg_sent)
Sender->>SenderDB: update(msg_status)
Django->>DjangoDB: store(msg)
Django->>DjangoRedis: findMsgReceiver(msg.receiverId)
DjangoRedis-->>Django: return channel_obj
alt No channel_obj
note right of Django: The message will be sent when the receiver is online
else channel_obj exists
Django->>Receiver: sendMessage(msg)
Receiver->>ReceiverDB: store(msg)
Receiver-->>Django: return confirmationId
alt No confirmationId
note right of Django: Wait for receiver to confirm message receipt
else confirmationId exists
Django->>Sender: status(msg_received)
Sender->>SenderDB: update(msg_status)
Django->>DjangoDB: delete(msg.id)
end
end
```
## API Reference
TODO
## Authors
- [@pablonicolla](https://github.com/PabloNicolla)