Giter Club home page Giter Club logo

realtime-chat's Introduction


Real-time chat application

Table of Contents
  1. About The Project
  2. Features
  3. Installation
  4. Contributing
  5. Contact

About the project

Product Name Screen Shot

Here's a simple multiple user chat application for real-time messaging written in GoLang and React framework

Technologies

  • GoLang-logo
  • React-logo
  • PostgreSQL-logo
  • JavaScript-logo

(back to top)

Features and implementations

  • Real‐time messaging for multiple users (Used WebSocket protocol for connection, goroutines and channel for asynchronous operation)
  • Authorization and authentication (By storing JSON Web Tokens in Cookies)
  • Users' Database (Implemented using GORM ORM library and PostgreSQL)

(back to top)

Installation

Server setup

  1. Go version 1.16 or greater installed. To set this up, visit the https://go.dev/doc/install to install it for your operation system

  2. In case you are setting up the server, it will be required to use PostgreSQL database server, visit https://www.postgresql.org/download/ and follow the installation instructions

  3. Clone the repo

git clone https://github.com/ssergomol/Realtime-Chat
  1. By default server tries to connect to database realtimechat using your system username. To change connection parametres, go through the backend/pkg/database/connection.go file

  2. Install dependencies

go mod download
  1. Start server
# cd backend/cmd
go run main.go

Client setup

  1. Install node package manager
npm install npm@latest -g
  1. Start React server
# cd frontend
npm start

(back to top)

Contributing

If you have any intentions that would make this project better, fork the repo and create pull request

  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)

Contact

Sergey Molchanov - @ssergomol - [email protected]

Project Link: https://github.com/ssergomol/Realtime-Chat

(back to top)

realtime-chat's People

Contributors

ssergomol avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.