Skip to content

Latest commit

 

History

History
96 lines (61 loc) · 1.76 KB

README.md

File metadata and controls

96 lines (61 loc) · 1.76 KB
Raw

➕ on-snip

on-snip is a real-time collaborative messaging platform built with Next.js, Express, Socket.IO, and Redis.

on-snip logo

Features

  • Create and join instant messaging rooms
  • Real-time message updates
  • Persistent message storage

Tech Stack

  • Frontend: Next.js 14, TypeScript, Tailwind CSS, React Query
  • Backend: Express.js, Socket.IO
  • Database: Redis (Upstash)
  • Deployment: Vercel (frontend), Heroku (backend)

Local Setup

Frontend Setup

  1. Clone the repository:

    git clone https://github.com/SanyamPunia/on-snip.git
cd on-snip/client

  2. Install dependencies:

    yarn install

  3. Create a .env file in the client directory with the following content:

    UPSTASH_REDIS_REST_URL=...
UPSTASH_REDIS_REST_TOKEN=...

  4. Start the development server:

    yarn dev

Backend Setup

  1. Navigate to the backend directory:

    cd ../server

  2. Install dependencies:

    yarn install

  3. Create a .env file in the server directory with the following content:

    REDIS_CONNECTION_STRING=...
PORT=8080

  4. Start the backend server:

    yarn dev

Deployment

  • Frontend: The Next.js app is deployed on Vercel.
  • Backend: The Express server is hosted on Heroku.

Production

Visit https://on-snip.org to see the live application.

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

TO-DO

  • Redirect with captcha (priority)

License

This project is licensed under the MIT License - see the LICENSE file for details.