Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/muhreeowki/chat-app
This is a distributed chat application.
https://github.com/muhreeowki/chat-app
Last synced: 11 days ago
JSON representation
This is a distributed chat application.
- Host: GitHub
- URL: https://github.com/muhreeowki/chat-app
- Owner: muhreeowki
- Created: 2024-09-17T07:24:56.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2024-09-24T14:35:40.000Z (4 months ago)
- Last Synced: 2024-12-03T09:54:53.920Z (about 2 months ago)
- Language: TypeScript
- Size: 44 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Real-Time Chat Application
## Overview
This project is a real-time chat application built with Go (backend) and Next.js (frontend). It leverages WebSocket connections to provide instant messaging capabilities. The application is designed to run on a single server, demonstrating efficient management of concurrent connections and real-time state updates.
## Key Features
- Real-time messaging using WebSockets
- Go backend for efficient concurrent connection handling
- Next.js frontend for a responsive user interface
- PostgreSQL database for data persistence
- Docker support for easy deployment and development## Prerequisites
Before you begin, ensure you have the following installed:
- [Go](https://golang.org/doc/install) (version 1.16 or later)
- [Node.js](https://nodejs.org/en/download/) (version 20 or later)
- [Docker](https://docs.docker.com/get-docker/)
- [Docker Compose](https://docs.docker.com/compose/install/)
- [Make](https://www.gnu.org/software/make/)## Installation
1. Clone the repository:
```
git clone https://github.com/muhreeowki/chat-app.git
cd chat-app
```## Running the Application on Docker
To start the entire application using Docker:
1. Build and Start the containers:
```
make docker-up
```
This will start the containers and have them running in the background.
Access the application by opening a web browser and navigating to `http://localhost:3000`2. To stop and remove the containers:
```
make docker-down
```
3. To remove the installed images form your system:
```
make docker-rmi
```## Contributing
Contributions are welcome! Please feel free to submit a Pull Request.
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.