MeNicefellow / NestTalk

NestTalk

NestTalk is a communication tool designed to keep families and close friend circles connected through real-time messaging. Built with simplicity and intimacy in mind, NestTalk allows users to easily set up private chat environments to share moments, coordinate plans, and stay close, no matter the distance.

Features

• Real-time Messaging: Send and receive messages instantly with your loved ones.
• Group Support: Designed to support communication within families or friend circles.
• User Authentication: Register and login to maintain secure access to your communication circles.
• Online Presence Indicators: See who's online and available for a chat.

Installation

Prerequisites

• Python 3.8+
• pip for installing Python packages

Setting Up

1. Clone the Repository

   git clone https://yourrepositoryurl.com/NestTalk.git
   cd NestTalk
   

2. Install Dependencies

   pip install -r requirements.txt
   

3. Configuration

   • Modify the server_config.yaml and client_config.yaml files in the server and client directories to match your setup requirements (IP addresses, ports, database paths, etc.).

Running the Application

1. Start the Server

   python server\server.py
   

2. Run the Client

   python client\client.py
   

Usage

• Register/Login: Start the client application and follow the prompts to either register a new user or log in with existing credentials.
• Send Messages: Once logged in, choose from the list of online users and start chatting.
• Logout: Ensure to logout properly to set your status to offline.

License

This project is licensed under the terms of the Apache 2.0 License.

Disclaimer

Use of NestTalk is at your own risk. While we strive to provide a secure and reliable platform, we cannot guarantee absolute security. Please be mindful of the information you share and with whom you share it. We are not responsible for any damages or losses related to the use of our software.

You can add this section wherever you think it fits best in your README.MD file.

Discord Server

Join our Discord server here.

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

Feeling Generous? 😊

Eager to buy me a cup of 2$ coffe or iced tea?🍵☕ Sure, here is the link: https://ko-fi.com/drnicefellow. Please add a note on which one you want me to drink?