Skip to content

Latest commit

 

History

History
85 lines (54 loc) · 2.53 KB

README.md

File metadata and controls

85 lines (54 loc) · 2.53 KB
Raw

Grid Chat

A Chat app built with Trpc, Tailwind CSS, Ably, Redis, Cloudinary, Drizzle ORM, Next 13.

This repository is a monorepo (Turborepo).

preview

Features

  • Create, Update, Delete Chat Group
  • Send, Update, Delete Message
  • Markdown (gfm, tables supported) in Messages
  • Reference Messages
  • Message Embeds (Display open-graph data of links in message)
  • Send Images/Files via Message
  • Direct Message with anyone
  • View & Kick Group members
  • Invite Group members via Invite code or Url
  • Upload profile images
  • Show notification when new Message received
  • AI-Powered Message Writer
  • Built-in AI Chatbot (Powered by Inworld)
  • Light & Dark Mode
  • 100% Typescript

Play with it: https://grid-chat.vercel.app
Learn More: https://grid-chat.vercel.app/info

TODO

  • migrate from PlanetScale to NEON DB
  • add Google OAuth

Play with it Locally

Grid Chat integrated with many third-party service for supporting wide spectrum of features and work perfectly on serverless environment.

Thus, you have to register an account for each services in order to setup the project correctly before playing with it locally. Please fill all environment variables in the .env.example.

Upstash

Create a Redis database at their website and get REDIS_URL, REDIS_TOKEN from the console.

Ably Realtime

Create a new project on https://ably.com, paste ABLY_API_KEY into environment varibles.

PlanetScale

By default, it uses Drizzle ORM with PlanetScale for database. You may use other providers if you prefer.

Create a MySQL database at their dashboard and get your DATABASE_URL and DATABASE_PUSH_URL.

Note

DATABASE_PUSH_URL is used for pushing changes which has pool connections disabled.

Cloudinary

Create a new project on https://cloudinary.com, copy the cloud name, key and API secret.

Next Auth

Fill NEXTAUTH_URL and NEXTAUTH_SECRET, read their docs for further details.

Currently, only Github OAuth is supported. Follow this guide to setup the OAuth App on Github, generate a GITHUB_ID with GITHUB_SECRET.

Development Mode

Run pnpm run dev and edit files to see changes.

Build from Source

This project uses Turborepo and PNPM.

pnpm run build

It should be able to deploy on Vercel or any other platforms.

grid-chat