https://github.com/portexe/ephemeral-live-feed

A simple pub/sub demo using React and Rails
https://github.com/portexe/ephemeral-live-feed

Last synced: 4 days ago
JSON representation

A simple pub/sub demo using React and Rails

• Host: GitHub
• URL: https://github.com/portexe/ephemeral-live-feed
• Owner: portexe
• Created: 2023-11-04T15:38:29.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2023-11-12T16:08:25.000Z (about 1 year ago)
• Last Synced: 2023-11-12T18:31:35.031Z (about 1 year ago)
• Language: Ruby
• Homepage:
• Size: 122 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
A simple Pub/Sub app made entirely for fun.

# Overview

The idea is very simple and pointless (but fun). A user signs in and selects from 4 topics to listen to. They will be directed to a live feed where they can view messages in real time as they are broadcasted. The feed is ephemeral. So once the user refreshes, all of the messages are gone. In the long term this could be an interesting mechanism to play around with as a unique social media app.

### Backend:

The backend is a Ruby on Rails app that serves up a React UI via `vite-rails`. The backend also serves as an API for the client.

### Frontend

The frontend is a React app using Vite. HMR enabled 😊

### Authentication

As of now the app is using session authentication with Devise. I chose not to go with JWT here just to keep things simple.

### Broadcasting

I am using the `Faker` gem to produce random messages to broadcast to a random topic every 10 seconds.

### Real time messages

The client connects to the server via Web Sockets (`ActionCable`) to subscribe to the appropriate topic channels and receive messages in real time.

### Testing

None yet. This app is mostly just for tinkering and experimenting. If I decide to add tests I will likely use `vitest` for the FE, and the built in framework provided by Rails for the BE.

# Running the app

1. Make sure to seed the database.

2. Run `bundle install` and `npm install` to install all necessary dependencies.

3. Run `npm run dev` to run both the frontend and backend together.