https://github.com/thefeij/chat-hub

A Simple Chat Server
https://github.com/thefeij/chat-hub

css docker gin-gonic golang gorilla-websocket gorm html javascript paseto-tokens postgresql unit-testing

Last synced: 6 months ago
JSON representation

A Simple Chat Server

• Host: GitHub
• URL: https://github.com/thefeij/chat-hub
• Owner: TheFeij
• Created: 2024-05-30T15:38:56.000Z (about 2 years ago)
• Default Branch: master
• Last Pushed: 2024-06-05T09:24:11.000Z (about 2 years ago)
• Last Synced: 2025-02-01T17:44:19.010Z (over 1 year ago)
• Topics: css, docker, gin-gonic, golang, gorilla-websocket, gorm, html, javascript, paseto-tokens, postgresql, unit-testing
• Language: Go
• Homepage: https://chat-hub.liara.run
• Size: 181 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md

Awesome Lists containing this project

README

          
# Chat Hub

A chat server developed with Golang.

Signup and chat with other people in the hub!

![Chat Page Screenshot](./screenshots/chat.png)

Website: https://chat-hub.liara.run

## Table of Contents

- [Introduction](#introduction)

- [Features](#features)

- [Usage](#usage)

- [API Endpoints](#api-endpoints)

## Introduction

This project is a chat server developed with golang. Users can sign up

in the server and join the chat server where they will be able to chat with 

other people in the hub. Chats are stored in the server so messages will remain

in the chat and users are able to see previous messages

## Features

This project uses

- [Gin](https://github.com/gin-gonic/gin) as its HTTP web framework to develop REST APIs

- [GORM](https://gorm.io/) as its ORM to interact with the database

- [Postgresql](https://www.postgresql.org/) as the database

- [Gorilla websocket](https://github.com/gorilla/websocket) package to handle websocket connections

- [Docker](https://www.docker.com/) to create docker image of the app

- [PASETO](https://paseto.io/) tokens to handle Authorization logic

## Usage

### Sign Up

Choose a username and password and sign up!

![Sign up Page Screenshot](./screenshots/singup.png)

### Login

If you already have an account, enter your username and password and log in!

![Login Page Screenshot](./screenshots/login.png)

### Chat

After a Successful login or signup now you can chat with other people in the hub!

![Chat Page Screenshot](./screenshots/chat.png)

## API Endpoints

- POST /api/signup ---> signup a new user.

- POST /api/login ---> login user.

- POST /api/refresh ---> refresh access token.

- GET /api/chat ---> start a websocket connection with the server