https://github.com/avd1729/sync-chat
This project is a real-time chat application built using Go, Fiber, and HTMX. It allows users to join a single chat room and send messages in real-time. The backend is powered by Go and Fiber, a fast HTTP framework, while HTMX is used for dynamic, real-time interactions on the frontend without requiring a full page reload.
https://github.com/avd1729/sync-chat
golang htmx-go websocket
Last synced: 5 months ago
JSON representation
This project is a real-time chat application built using Go, Fiber, and HTMX. It allows users to join a single chat room and send messages in real-time. The backend is powered by Go and Fiber, a fast HTTP framework, while HTMX is used for dynamic, real-time interactions on the frontend without requiring a full page reload.
- Host: GitHub
- URL: https://github.com/avd1729/sync-chat
- Owner: avd1729
- License: apache-2.0
- Created: 2024-06-08T14:38:25.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-06-10T11:20:46.000Z (about 2 years ago)
- Last Synced: 2024-06-10T16:23:54.943Z (about 2 years ago)
- Topics: golang, htmx-go, websocket
- Language: Go
- Homepage:
- Size: 24.4 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Sync-Chat
## Table of Contents
- [Introduction](#introduction)
- [Features](#features)
- [Prerequisites](#prerequisites)
- [Installation](#installation)
- [Configuration](#configuration)
- [Running the Application](#running-the-application)
- [Usage](#usage)
- [Contributing](#contributing)
- [License](#license)
## Introduction
This project is a real-time chat application built using Go, Fiber, and HTMX. It allows users to join a single chat room and send messages in real-time. The backend is powered by Go and Fiber, a fast HTTP framework, while HTMX is used for dynamic, real-time interactions on the frontend without requiring a full page reload.
## Features
- Real-time messaging using WebSockets
- Single chat room
- User-friendly interface
- Lightweight and fast
- Easy to deploy
## Prerequisites
Before you begin, ensure you have the following installed:
- [Go](https://golang.org/dl/) (version 1.22 or later)
- [Fiber](https://gofiber.io/)
- [HTMX](https://htmx.org/)
## Installation
1. **Clone the repository:**
```bash
git clone https://github.com/your-username/realtime-chat-app.git
cd realtime-chat-app
```
2. **Install Go dependencies:**
```bash
go mod download
```
## Configuration
Create a `.env` file in the root directory and add the following configuration variables:
```env
PORT=3000
```
You can modify the values according to your environment.
## Running the Application
1. **Start the Go server:**
```bash
go run main.go
```
2. **Open your browser and navigate to:**
```bash
http://localhost:3000
```
## Usage
- Open the app in your browser.
- Join the chat room.
- Start sending messages in real-time.
## Contributing
Contributions are welcome! Please fork the repository and use a feature branch. Pull requests are reviewed on a regular basis.
1. Fork the repository
2. Create your feature branch
3. Commit your changes
4. Push to the branch
5. Create a new Pull Request
## License
This project is licensed under the Apache 2.0 License. See the [LICENSE](LICENSE) file for details.