Sync Chat

Features · Downloads · Building from Source · Setting Up · FAQs

Sync Chat is an open-source realtime chat application for one-to-one communications. It is built using nextjs 14. It has responsive design to support mostly all platforms. It uses AES encryption. It stores messages in a Database to provide chat histroy.

 

✨ Features

• AES Encryption
• Chat history
• one-to-one
• Realtime

🔧 Building from Source

The client can also be built from source for individual platforms.

Prerequisites

• Git CLI
• NodeJS
• Docker

Building

1. Clone the repository and cd into it.

       git clone https://github.com/Bikram-ghuku/SyncChatServer.git
       cd ChatSyncWeb

2. Install required modules

       npm i

3. Setup Docker for PostgreSQL server

     docker compose up

4. Run the development server

       npm run dev

5. Setup the envrionment

   • Rename the .env.example to .env
   • Set DATABASE_URL = "postgresql://username:password@localhost:5432/database?schema=public" if using docker PostgresSQL
   • Fill the required tokens

Visit the application at: http://localhost:8080/

6. Setup the database

   npx prisma migrate deploy

 

📜 License

SyncChat is released under the MIT license, which grants the following permissions:

• Commercial use
• Distribution
• Modification
• Private use

For more convoluted language, see the LICENSE.