Skip to content
This repository was archived by the owner on Feb 17, 2025. It is now read-only.

tresr-community/chatbot

Repository files navigation

ChatBot

The NFTREASURE Community ChatBot

This repository contains the source files for the Ron Jay ChatBot

This is an unofficial chatbot for the NFTREASURE Community and is not affiliated with the NFTREASURE project.

It is made with ❤️ love ❤️ for the NFTREASURE Community.

How to run locally

# Get the dependencies
just -q init

# Login to Cloudflare
just -q login

# Build the local workers
just -q build

# Start the local workers
just -q start

# Stop the local workers
just -q stop

How to test locally

There are a few URLs that you can use to test the chatbot locally depending on the worker.

Caddy

The caddy server is used to proxy the chatbot requests to the correct worker.

Access Caddy at: https://localhost:9000

Frontend

The frontend worker is the main entry point for the chatbot. It is responsible for rendering the chatbot UI using Astro.

Access to the Frontend Worker is via Caddy at: https://localhost:9000 -> http://localhost:9100

The frontend worker embeds the UI Widget worker on he main page behind a button.

Backend

The backend worker is responsible for handling the chatbot API requests and responses.

Access to the Backend Worker is via Caddy at: https://localhost:9000/api -> http://localhost:9200

Roadmap

  • ☑️ Add an Index page with Ron Jay crypto quotes
  • ☑️ Add dark/light mode toggle
  • ☑️ Add a fullscreen chatbot page that uses the 'chatbot' backend
  • ☑️ Add a widget chatbot page that uses the 'chatbot' backend toggled via a button.
  • ☑️ Add a Bitcoin loader to the widget.
  • ☑️ Add a button to show/hide the widget.
  • ☑️ Make the ChatBot style toggle with the dark/light mode toggle.
  • ☑️ Implement Token Authentication for the Cloudflare AI Gateway.
  • ☑️ Implement Cloudflare AI Gateway with Google AI Studio backend for the Widget.
  • ☑️ Implement Cloudflare AI Gateway with Google AI Studio backend for the Fullscreen.
  • ☑️ Implement Cloudflare AI Gateway with Grok backend for the Widget.
  • ☑️ Implement Cloudflare AI Gateway with Grok backend for the Fullscreen.

Refactor Roadmap

  • ☑️ Refactor into two simple workers: frontend and backend.
  • ☑️ Refactor the frontend to be a static site generated with Astro.
  • ☑️ Refactor the backend to be a Cloudflare AI Gateway using workers-rs

Frontend Roadmap

  • ☑️ Astro
  • ☑️ Bun
  • ☑️ Tailwind CSS
  • ☑️ Health URL on frontend worker at /health
  • ☑️ Caddy working for local development
  • ☑️ Implement the quotes page on the frontend worker at the index / page
  • ☑️ Implement the PWA on the frontend worker
  • ☑️ Make the speech bubble quote text update every 5 seconds and look like a speech bubble.
  • Pass ESLint on the frontend and backend workers
  • Get the CI to deploy the frontend worker to Cloudflare Pages
  • Fullscreen mode on frontend worker at /fullscreen which is a standalone chatbot page.
  • Widget mode on frontend worker at /widget which can be embedded in any website.

Backend Roadmap

  • Chatbot support on backend worker at /api/v1/chatbot
  • Grok support on backend worker at /api/v1/grok
  • Google support on backend worker at /api/v1/google

About

A ChatBot for the NFTREASURE community

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors