Giter Club home page Giter Club logo

simple_chat's Introduction

Flask-SocketIO Chat Backend

Installation

Both Docker and docker-compose should be installed.

git clone https://github.com/Telichkin/simple_chat.git
cd simple_chat
docker-compose build
docker-compose up

Application will run on http://localhost:8000

API

User creation:

POST /users/
Content-Type: application/json

{"username": "newUser", "password": "Weak!"}

Authentication:

POST /auth/
Content-Type: application/json

{"username": "matureUser", "password": "Strong?"}

Both creation and authentication methods return token in response body.

Backend can get events:

/

event required payload fields
"auth" "token"
"send private message" "message", "to"
"broadcast" "message"
"connect" None
"disconnect" None

Before start to use other events you need to authenticate through "auth" event with token.

/active-users

event required payload fields
"connect" None
"disconnect" None

Backend can send events:

/

event data
"send private message" {"message": .., "author": .., "to": ..}
"broadcast" {"message": .., "author": .., "to": None}
"private history" list with messages from "send private message"
"broadcast history" list with messages from "broadcast"
"error" error message

/active-users

event data
"update" list with user names of active users

simple_chat's People

Contributors

telichkin avatar

Watchers

 avatar  avatar  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.