Skip to content

Latest commit

 

History

History
32 lines (21 loc) · 1.05 KB

README.md

File metadata and controls

32 lines (21 loc) · 1.05 KB
Raw

TerminalChat

Simple terminal chat backend and CLI to send messages.

CLI installation

pip install TerminalChat (Hosted on PyPi)

CLI Usage

Usage: tchat [OPTIONS] COMMAND [ARGS]

Commands:

  • tchat read Command to get unread messages, use -a or --all to get all messages.
  • tchat send Command to send a message. CLI walks through the steps.
  • tchat sign-up Command to sign up for the first time.

Run backend locally (optional)

TerminalChat backend is hosted on Azure, so no need to run your own server (unless you want to).

  1. Clone repo with git clone git@github.com:noah-solomon/terminal-chat.git
  2. Enter backend directory with cd terminal-chat/backend/src

With Docker

  1. Create & run Docker container with docker-compose up -d

Without Docker

  1. Make a virtual environment with python3 -m venv venv
  2. Activate your virtual environment with source venv/bin/activate (Mac)
  3. Install requirements with pip install requirements.txt
  4. Run server with python3 app.py