README.md

Private-Communicator-API

Encryption-protected messaging app

Table of Contents

• Private-Communicator
  • Introduction
  • Features
  • Future Features
  • Installation
    • Prerequisites
    • Setup
  • Usage
  • Documentation
  • Contributing
  • Authors
  • License

Introduction

This API Communicator is a simple messaging app that allows two users to communicate with each other. The API endpoints accept HTTP request and return JSON responses. The detailed documentation of the API endpoints can be found here.

Features

• Accountless messaging
• End-to-end encryption
• No message history

Future Features

• User accounts

Installation

Prerequisites

• Python 3.6+
• pip

Setup

1. Clone the repository

git clone https://github.com/NaviteLogger/Private-Console-Communicator.git

(Optional) Create a virtual environment

python -m venv venv

2. Install the required packages

pip install -r requirements.txt

Usage

1. Start the server

python app.py

Documentation

The detailed documentation of the API endpoints can be found here.

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Authors

• NaviteLogger

License

This work is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License.