Go WebSocket Project Documentation

Table of Contents

1. Project Overview
2. Installation Instructions
3. Usage
4. API Endpoints
5. Dependencies
6. Example
7. Todo

Project Overview

This project is a WebSocket server written in Go. It allows real-time communication between clients and the server.

Installation Instructions

Prerequisites

• Go version 1.16 or higher
• Git

Steps

1. Clone the Repository

   git clone https://github.com/yossev/go-websocket-chat.git
   cd go-websocket-chat

2. Install Dependencies

   go mod tidy

3. Run the Server

Usage

```sh
go run main.go
```

Usage

1 - Run the server.go file.
2 - Run the HTML File using any live preview extension, example

Api Endpoints

Coming Soon!

Websocket Endpoint

• Enpoint '/chat'
• Method GET
• Description: Establishes a WebSocket connection with the server.

Dependencies

• gorilla/websocket - WebSocket Library for Go.

Video Example

Paintapp.2024.07.19.-.21.39.11.01.mp4

Todo

• Add Mutlimedia sharing
• Publish on a Domain