MessenFlow

A simple messenger application built with Go, supporting user registration, login, message sending, editing, and deleting.
Explore the docs »

· Report Bug · Request Feature

Table of Contents

1. About The Project
   • Application Functionality
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License

About The Project

MessenFlow is a basic yet functional messenger application that allows users to register, log in, and chat with others. Users can send, edit, and delete their own messages in real-time, leveraging WebSocket for instant communication. The backend is powered by Go, with a simple frontend built using HTML, CSS, and JavaScript. SQLite is used for data storage, keeping the application lightweight and easy to set up.

Application Functionality

Log in

Below is an example of the login process:

Login process

Chatting

Example of interaction in the chat:

Chat interaction

Editing Message

Shows how to edit a message:

Editing a message

Deleting Message

Example of deleting a message:

Deleting a message

Mobile Screen

Here's how the application looks on a mobile device:

Application on mobile screen

(back to top)

Features

• Real-time messaging using WebSocket
• User registration and authentication
• Edit and delete messages

(back to top)

Built With

• 
• 
• 
• 
• 
• 

(back to top)

Getting Started

To get a local copy of this project up and running, follow the steps below.

Prerequisites

Ensure you have Go installed on your machine. You can download it from Go's official website.

---

Installation

1. Clone the repository:

   git clone https://github.com/Propolisss/MessenFlow.git

2. Navigate to the project directory:

   cd MessenFlow

3. Build and run the project:

   You can specify the IP address and port on which the application will run. If not provided, the default values will be used.

   To run with default settings (IP: localhost, Port: 8080):

   go run cmd/myapp/main.go

   To run with custom IP and Port:

   go run cmd/myapp/main.go --address=<your_ip> --port=<your_port>

   Replace <your_ip> with the desired IP address (e.g., 127.0.0.1), and <your_port> with the desired port number ( e.g., 8081).

4. Open your browser and navigate to the specified address:

   http://<your_ip>:<your_port>

   If you used the default settings, navigate to:

   http://localhost:8080

(back to top)

---

Usage

Once the server is running, you can register a new user, log in, and start sending messages to other registered users. You can also edit or delete your messages.

(back to top)

Roadmap

• Add online/offline status
• User authentication improvements
• Implementing user roles and permissions
• Adding file attachment support
• Enhance UI/UX with modern frameworks
• Add voice and video messages
• Add password encryption
• Refactor chatID system
• Add writing... status

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 an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this project 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)

Top contributors:

License

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

(back to top)

---