Documentation

TerminalTalk is a command-line decentralized chat application that allows users to host their own server and communicate with friends.

Description

TerminalTalk provides a seamless chatting experience directly through the terminal. Users can set up their server using tools like ngrok, creating a decentralized environment for secure and private conversations.

Tools Required

To use TerminalTalk, you'll need:

• Bun
• Ngrok or a similar tool for creating tunnels to host your server
• A terminal or command line interface

Installation

Prerequisites

Ensure you have Bun installed.

Steps

1. Clone the repository from GitHub.

   git clone https://github.com/TH3-MA3STRO/TerminalTalk.git

2. Navigate to the TerminalTalk directory.
3. Install dependencies by running:

   bun install

Usage

Hosting the Server

1. run the server.ts file

   bun run server.ts

2. In another window/tab run Ngrok or a similar tool to expose your local server to the internet:

   ngrok http 3000 // default is 3000

   or you can change the port by changing it on line 8 in server.ts file
3. Copy the generated URL and share it with your friends.

Joining the Chat

1. Edit the client.ts file and replace 'PATH-TO-SERVER' in line 84 with the URL generated in the aforementioned step

2. Run the client.ts file:

   bun run client.ts

3. Enter your name and room id separated by a ":"

   <NAME>:<ROOM ID>
   

   and hit enter

4. Start chatting!

Chatting Window

1. Hitting insert key focuses the inputbox
2. Hitting enter sends the text
3. You can exit the insert mode by hitting escape key, pressing escape one more time will stop the program