NuxtChat Starter

📔 About the Project

🌟 What is this

NuxtChat is an open-source chat platform that allows users to chat anonymously with real people and AI personas.
It's designed to provide a secure, fun, and interactive chat experience while maintaining privacy.

NuxtChat is a Nuxt Starter for Real Time Chat based on Supabase. It's early and a bit rough, but if you're working on creating a chat app, integrating Supabase Real Time or playing with AI integration, this code might be helpful.

⭐ Features

• 🏆 AI-powered conversations - Talk with AI-powered personalities
• 👥 Anonymous or Registered Users - Stay anonymous or create an account
• 🔒 Privacy-first - No forced logins, no tracking
• 🌍 Open Source - Community-driven development

📷 Screenshots

🧰 Getting Started - Step by Step Guide on how to configure NuxtChat locally

Prerequisites

In order to follow along with this installation, you’ll need access to a Supabase database, an OpenAI account, and the API keys that come with it. This guide assumes that you already have an account on both platforms.

If you don’t have an account and would like to set one up yourself, you can follow one of our guides on How To Install NuxtChat.

Step 1) Cloning

Clone the project

  git clone git@github.com:jefhild/NuxtChat.git

Go to the project directory

  cd NuxtChat

🔑 Step 2) Setup .env

To run this project, you will need to add the following environment variables to your .env file. You can access these keys in your supabase database settings and OpenAI account keys

• SUPABASE_URL

• SUPABASE_KEY

• SUPABASE_BUCKET

• SUPABASE_REDIRECT

• OPENAI_API_KEY

Create a .env file and add the environment variables listed above.

📁 Step 3) Database creation and initialisation

The repository provides create.sql, functions.sql and init.sql scripts, which you can execute using the Supabase SQL Editor.

First, copy the contents of the create.sql file and paste and run the query in the Supabase SQL Editor. After that, execute the functions.sql and lastly the init.sql file.

Step 4) Install the server dependencies

Make sure to install the project's dependencies:

# npm
npm install

Step 5) The Development Server

Start the development server on http://localhost:3000:

# npm
npm run dev

❓ Need any help

If you need any help with getting started, please consult our How To Install NuxtChat guide.

👋 Contributing

Contributions are always welcome!

To get started contributing to the project, see the contributing guide. This document also includes guidelines for reporting bugs.

📋 Tracking Work (Todos and Change Requests)

To keep work portable across machines, track tasks directly in the repo:

• docs/TODO.md for small, code-level tasks.
• docs/CHANGE_REQUESTS.md for larger product or cross-cutting requests.
• GitHub Issues for discussion-heavy items:
  • Bug report: .github/ISSUE_TEMPLATE/bug_report.md
  • Change request: .github/ISSUE_TEMPLATE/change_request.md
  • Tech debt: .github/ISSUE_TEMPLATE/tech_debt.md

Recommended flow:

1. Capture quickly in docs/TODO.md or docs/CHANGE_REQUESTS.md.
2. Open a GitHub issue when collaboration or design discussion is needed.
3. Link issue IDs next to markdown items.
4. Move completed items to each file's Done section with a date.

⚠️ License

Distributed under the MIT License. See LICENSE for more information.

🤝 Contact

Oliver W Jones - Our site

Project Link: https://github.com/jefhild/NuxtChat

💡 Enjoy chatting with AI & real people! 🚀 🌟 Star this repo if you like this project! ⭐