TheGroundFloor™ - Part of The Building project

A CLI for texting your friends

Table of Contents

1. About The Project
2. Getting Started
3. Usage
4. TODO
5. Contributing
6. License
7. Contact

About The Project

TheGroundFloor™ is aimed towards creating a fast, secure, lightweight CLI for texting your friends. No more Mr. Zuckerberg stealing your data. The project makes use of multi-threading and PostgreSQL to send and receive messages from 2 clients.

Features

1. Login/Create user (Supporting hashing of passwords)
2. Notifications for friend requests and unread messages
3. Sending friend requests, accepting/declining friend requests
4. Removing friends
5. Starting chatrooms (Supporting AES Encryption, can only send messages to your friends)
6. Plays a sound upon receiving a message
7. Changing default settings (Number of messages displayed upon starting chat room, etc.)
8. Strong error logging to help with future debugging

(back to top)

Built With

1. Python
2. PostgreSQL

(back to top)

Getting Started

1. Use the log.sql file in the directory get the commands through which you can create your own database.
2. You can host the database on a platform like bit.io.
3. After hosting the database, Make a filekeys.py file in the directory and add the following lines:

postgresqluri = "<YOUR POSTGRESQL DATABASE URI>"
referralkey = "<YOUR REFERRAL KEY>"
encryptkey =  b"<YOUR ENCRYPTION KEY>"
iv = b"<YOUR IV KEY>"

4. The "encryptkey" and "iv" keys are used to encrypt and decrypt the messages and MUST be 16 bytes long.
5. Voila! You can now text your friends using this CLI. Just send the main.py file to your friends or you can convert it to a .exe file and send it as an application!

Prerequisites

Go to the directory where you downloaded the project and run the following command in the terminal:

pip install -r requirements.txt

(back to top)

Usage

There's no instructions, just run main.py in your terminal and follow the instructions on the screen!

(back to top)

TODO

• Allow sending images and audio files to your friends.
• Make the UI more friendly and add color.
• Have the notifications autoupdate.
• Implement sending messages using websockets.

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Pratyush Shah - Email, LinkedIn

Project Link: https://github.com/pratyushvshah/TheGroundFloor

(back to top)