https://github.com/joupify/smartstay

Rails 7 app managing lodgings with Redis Stack, real-time notifications, full-text and AI-powered vector search using OpenAI embeddings.
https://github.com/joupify/smartstay

ai docker docker-compose openai rails real-time redis redis-cache redisclient redisearch ruby vector-search

Last synced: about 2 months ago
JSON representation

Rails 7 app managing lodgings with Redis Stack, real-time notifications, full-text and AI-powered vector search using OpenAI embeddings.

• Host: GitHub
• URL: https://github.com/joupify/smartstay
• Owner: joupify
• License: mit
• Created: 2025-07-24T20:49:58.000Z (10 months ago)
• Default Branch: main
• Last Pushed: 2025-08-17T01:48:35.000Z (10 months ago)
• Last Synced: 2025-08-17T03:12:39.337Z (10 months ago)
• Topics: ai, docker, docker-compose, openai, rails, real-time, redis, redis-cache, redisclient, redisearch, ruby, vector-search
• Language: Ruby
• Homepage:
• Size: 16.4 MB
• Stars: 0
• Watchers: 0
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# SmartStay – Redis + AI Challenge [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)

Rails 7 application for managing lodgings with Redis Stack, real-time notifications via ActionCable, and AI integration (vector search with embeddings).

## 🎯 Challenge Goal

Store lodgings exclusively in Redis (no SQL database).

Real-time notifications for creation, update, and deletion.

Full-text search with RediSearch.

AI similarity search using Redis Vector Search + embeddings (currently mock).

## ✅ Implemented Features

- ✔ CRUD for lodgings (stored in Redis)

- ✔ Real-time broadcasts via ActionCable

- ✔ User notifications with Bootstrap Toasts

- ✔ Full-text search via RediSearch

- ✔ Popularity tracking with Redis ZSET

- ✔ Event history via Redis Streams

- ✔ Minimal dashboard: Top popular lodgings + recent events

- ✔ Persistence enabled (AOF with Docker)

## 🔥 Upcoming Features

- 🔍 AI vector search with real OpenAI embeddings

- 🧠 AI Assistant for recommendations

- 📊 Advanced dashboard for analytics

- ✅ Deployment on Render + Redis Cloud

## 🛠 Tech Stack

- Ruby: 3.1.3

- Rails: 7.2.2.1

- Redis Stack: Search, Vector, Streams

- ActionCable: Real-time notifications

- Bootstrap 5: Responsive UI

- Docker: Redis Stack container

- AI: OpenAI embeddings (mocked if no key)

## 🔧 Installation & Setup

1️⃣ Clone the repo

git clone https://github.com/joupify/smartstay.git  

cd smartstay  

2️⃣ Install dependencies

bundle install  

3️⃣ Run Redis Stack with persistence

docker run -d \

 --name redis-stack \

 -p 6380:6379 \

 -p 8001:8001 \

 -v ~/redis-data:/data \

 redis/redis-stack:latest

Redis Insight GUI: http://localhost:8001

Redis accessible: localhost:6380

4️⃣ Start Rails server

App URL: http://localhost:3000

✅ Quick Check (Rails console)

service = RedisLodgingService.new

service.save_lodging(id: SecureRandom.uuid, title: "Cozy studio", description: "Nice studio with balcony", price: 600)

service.list_all_lodgings

🔍 Search (RediSearch)

service.text_search("studio")

(Index is auto-created if missing)

🤖 AI Similar Search

Uses **OpenAI embeddings** (model: `text-embedding-3-small`) when `OPENAI_API_KEY` is set.

Falls back to mock embeddings only if no API key is provided.

Button **"Find Similar"** triggers semantic search via Redis Vector Search (KNN).

📡 Real-time Notifications

Open 2 browser tabs, add a lodging → instant notification (via ActionCable)

UI (Bootstrap Toast container):





📊 Dashboard

Total Lodgings

Top Popular Lodgings (via ZSET)

Recent Events (via Redis Streams)

✅ Redis Persistence  

Enable AOF:

docker exec -it redis-stack redis-cli CONFIG SET appendonly yes

docker exec -it redis-stack redis-cli CONFIG REWRITE

📸 Screenshots  

See screenshots in the French section below.

✅ Next Steps

Switch from mock embeddings → real OpenAI API

Deployment on Render + Redis Cloud

Add analytics (stream aggregation)

## 🎥 Demo Video

Watch the full demo with subtitles:  

[▶ Watch on Youtube](https://youtu.be/pAIY7tOzB7I)

## 📄 License

This project is licensed under the [MIT License](LICENSE).

## 👩‍💻 Author

**Malika (joupify)**  

[GitHub](https://github.com/joupify)

[![DEV Post](https://img.shields.io/badge/DEV-Read%20Article-black?logo=dev.to)](https://dev.to/joupify/smartstay-redis-powered-real-time-ai-lodging-manager-51o8)

## 🤝 Contributing

Contributions are welcome!  

Feel free to fork the repo and submit a Pull Request.

## 🇫🇷 Version Française

Application Rails 7 pour la gestion des logements avec Redis Stack, notifications en temps réel via ActionCable, et intégration IA (recherche vectorielle avec embeddings).

🎯 Objectif du Challenge

Stocker les logements exclusivement dans Redis (sans base SQL)

Notifications en temps réel (création, mise à jour, suppression)

Recherche textuelle avec RediSearch

Recherche similaire via Redis Vector Search + embeddings IA (mock actuellement)

✅ Fonctionnalités Implémentées  

✔ CRUD complet (logements stockés dans Redis)

✔ Diffusion temps réel avec ActionCable

✔ Notifications utilisateur (Bootstrap Toasts)

✔ Recherche textuelle rapide grâce à RediSearch

✔ Suivi de popularité avec Redis ZSET

✔ Historique des événements avec Redis Streams

✔ Mini-dashboard : Top logements + événements récents

✔ Persistance activée (AOF avec Docker)

🔥 Fonctionnalités à venir

🔍 Recherche vectorielle IA avec embeddings OpenAI réels

🧠 Assistant IA pour recommandations

📊 Tableau de bord avancé pour les statistiques

✅ Déploiement sur Render + Redis Cloud

🛠 Stack Technique

Ruby : 3.1.3

Rails : 7.2.2.1

Redis Stack : Search, Vector, Streams

ActionCable : Notifications temps réel

Bootstrap 5 : Interface responsive

Docker : Conteneur Redis Stack

IA : OpenAI embeddings (mock si clé absente)

🔧 Installation & Configuration

1️⃣ Cloner le projet

git clone https://github.com/joupify/smartstay.git

cd smartstay  

2️⃣ Installer les dépendances

bundle install  

3️⃣ Lancer Redis Stack avec persistance

docker run -d \

 --name redis-stack \

 -p 6380:6379 \

 -p 8001:8001 \

 -v ~/redis-data:/data \

 redis/redis-stack:latest

Interface Redis Insight : http://localhost:8001

Redis accessible : localhost:6380

4️⃣ Démarrer le serveur Rails

bin/dev

Application : http://localhost:3000

✅ Vérification rapide (console Rails)

service = RedisLodgingService.new

service.save_lodging(id: SecureRandom.uuid, title: "Studio cosy", description: "Bel studio avec balcon", price: 600)

service.list_all_lodgings

🔍 Recherche (RediSearch)

service.text_search("studio")

(L’index est créé automatiquement au démarrage si absent)

🤖 Recherche similaire IA

Utilise **les embeddings OpenAI** (modèle : `text-embedding-3-small`) si `OPENAI_API_KEY` est défini.  

Revient à des embeddings simulés uniquement si aucune clé API n’est disponible.  

Le bouton **"Voir similaires"** déclenche une recherche sémantique via Redis Vector Search (KNN).

📡 Notifications Temps Réel

Ouvrir 2 navigateurs, ajouter un logement → notification instantanée (via ActionCable)

UI (container Toast Bootstrap) :





📊 Dashboard  

Nombre total de logements

Top logements populaires (via ZSET)

Événements récents (via Redis Streams)

✅ Persistance Redis  

Activer AOF :

docker exec -it redis-stack redis-cli CONFIG SET appendonly yes

docker exec -it redis-stack redis-cli CONFIG REWRITE

### 📸 Captures d’écran

---

### Screenshots

📌 **Home Page (CRUD Operations)**  

![Home](docs/screenshots/home.png)

📌 **Real-Time Notifications (2 Browsers)**  

![Notifications](docs/screenshots/notif.png)

📌 **Text & AI-powered Search (See Similar Button)**  

![Search](docs/screenshots/search.png)

📌 **Dashboard (Top Lodgings & Recent Events)**  

![Dashboard](docs/screenshots/dashboard.png)

---

🔥 Fonctionnalités à venir

🔍 Recherche vectorielle IA avec de vrais embeddings OpenAI

🧠 Assistant IA pour recommandations

📊 Tableau de bord avancé pour les statistiques

✅ Déploiement sur Render + Redis Cloud

## 🎥 Demo Video

Watch the full demo with subtitles:  

[▶ Watch on Youtube](https://youtu.be/pAIY7tOzB7I)

## 👩‍💻 Author

**Malika (joupify)**  

[GitHub](https://github.com/joupify)

[![DEV Post](https://img.shields.io/badge/DEV-Read%20Article-black?logo=dev.to)](https://dev.to/joupify/smartstay-redis-powered-real-time-ai-lodging-manager-51o8)

## 📄 Licence

Ce projet est sous licence [MIT](LICENSE).