https://github.com/cmwylie19/realtimechat

An application that utilizes a caching strategies to manage concurrent users. Relies on rest and socket protocols for communication and keycloak for authentication. Written in React and Node. This app was developed as in conjunction with a blog, url of the blog coming soon!
https://github.com/cmwylie19/realtimechat

cache cache-strategy curl docker keycloak keycloak-instance nodejs patternfly react reactjs socket-io socket-io-client socket-io-server socketio

Last synced: 2 months ago
JSON representation

An application that utilizes a caching strategies to manage concurrent users. Relies on rest and socket protocols for communication and keycloak for authentication. Written in React and Node. This app was developed as in conjunction with a blog, url of the blog coming soon!

• Host: GitHub
• URL: https://github.com/cmwylie19/realtimechat
• Owner: cmwylie19
• Created: 2019-09-27T15:31:55.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2023-01-24T00:43:44.000Z (about 2 years ago)
• Last Synced: 2024-04-22T00:21:41.428Z (9 months ago)
• Topics: cache, cache-strategy, curl, docker, keycloak, keycloak-instance, nodejs, patternfly, react, reactjs, socket-io, socket-io-client, socket-io-server, socketio
• Language: JavaScript
• Homepage:
• Size: 23 MB
• Stars: 5
• Watchers: 2
• Forks: 5
• Open Issues: 27
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md

Awesome Lists containing this project

README

        

# Patternfly-Chat

  

Patternfly-Chat is a real time chat application that allows realtime communication for groups and individuals. 

It features an architecture comprised of a frontend, a cache micro service, a redis cache, and an instance of a keycloak server.

The authentication side is leveraged by Keycloak and which makes management of client applications, users, and assignment of permissions and roles extremely simple. Management of application concurrency is handled by the cache micro service which relies on composite key and streaming features of redis.

 The frontend communicates directly to keycloak server and the cache.

The frontend is React and the Cache is Node with es6 mods.

## Build Cache Service

> docker build -t cacheservice:chatapp .

> docker build -t frontend:chatapp .

# Backend API

Cache API, assuming the Cache is running on http://localhost:3332.

  

#### Set Key in Cache

Ex. Store birthMonth to July and give it a time to live of 10 minutes

> curl http://localhost:3332/store/600/birthMonth\?value=July 

>

#### Get Key from Cache

Ex. get birthMonth

> curl http://localhost:3332/name/birthMonth

>

#### Delete Key

Ex. Delete birthMonth

> curl http://localhost:3332/delete/birthMonth

>

#### Fetch All Keys

> curl http://localhost:3332/all 

>

________________________________________________________________________________________________________________________________________________________ 

# Set Up

All of the resources used in this app are run in docker containers. Everything is accessible locally and extremely simple and fast to spin up.

  

  

#### Cache Service

> docker run -d -p 6379:6379 redis

#### Auth Service

> docker run -p 8080:8080 -e KEYCLOAK_USER=admin -e KEYCLOAK_PASSWORD=admin -e DB_VENDOR=H2 jboss/keycloak

  

#### go to http://localhost:8080/auth/admin

#### username: admin, password: admin

![[Login|width=100px]](login.png)

  

  

#### Hover your mouse over the top of the left panel where is says "master" and a button will appear that says Add Realm.

![Add Realm](add.png)

  

#### Upload config file from realm-export.json from KeyCloak/Realms/realm-export.json

![Upload Config](upload.png)

________________________________________________________________________________________________________________________________________________________

#### Front End

> npm i && npm start

#### Cache 

> cd Cache; 

________________________________________________________________________________________________________________________________________________________ 

> npm i && npm start

________________________________________________________________________________________________________________________________________________________