⭐ Star this repo on GitHub to support the project and stay updated with the latest changes.

Konvo is a real-time chat application built with Next, Node.js, Express, and Socket.io. It allows users to communicate with each other in real-time through a web interface.

Table of Content

• Features
• Built with
  • Frontend
  • Backend
  • Database
  • Auth
• Before you start
• Getting started
  • Clone the repo
  • Install packages
  • Set up the env file
• Env variables
• Run it
  • Dev mode
  • Prod mode
• Want to help out?
• License
• Thanks

Features

• Real-time chat with Socket.io
• Sign up and log in with Better Auth
• Chat rooms you can join and switch between
• Dark and light mode
• Works on desktop and mobile

_{Back to Top}

Built with

Frontend

• Next.js (App Router)
• React
• Tailwind CSS
• shadcn/ui components
• Framer Motion for animations

Backend

• Node.js
• Express
• TypeScript

Database

• PostgreSQL

Auth

• Better Auth for sign up, log in and sessions

_{Back to Top}

Before you start

Make sure you have these installed:

• Node.js (v18 or newer)
• npm (comes with Node)
• A PostgreSQL database running somewhere (local or hosted)

_{Back to Top}

Getting started

Clone the repo

git clone https://github.com/Shaeikh/Konvo.git
cd Konvo

Install packages

npm install

Set up the env file

Copy the example file and fill in your own values:

cp .env.example .env

_{Back to Top}

Env variables

Variable	What it's for
BETTER_AUTH_SECRET	Secret key used by Better Auth. See the Better Auth docs
BETTER_AUTH_URL	The base URL of the app, e.g.http://localhost:3000
POSTGRESQL_URL	Your Postgres connection string
NEXT_PUBLIC_APP_URL	The app URL used in production
NEXT_PUBLIC_SOCKET_URL	Optional. Where the socket server runs. Left empty, it uses the base URL

_{Back to Top}

Run it

Dev mode

npm run dev

Open http://localhost:3000 in your browser.

Prod mode

npm run build
npm start

_{Back to Top}

Want to help out?

Contributions are welcome! Here's how:

1. Fork the repo
2. Make a new branch (git checkout -b my-feature)
3. Commit your changes (git commit -m "Add my feature")
4. Push the branch (git push origin my-feature)
5. Open a pull request

Found a bug? Feel free to open an issue.

_{Back to Top}

License

This project is licensed under the MIT License. See the LICENSE file for more info.

_{Back to Top}

Thanks

• Next.js for the framework.
• Better Auth for easy authentication
• Socket.io for real-time messaging
• shadcn/ui for the UI components
• Everyone who stars and shares the project ⭐
• Me who is brave enough to use Socket.io with Next

_{Back to Top}