Skip to content

himanshu8443/InkSync

Repository files navigation

Project Banner

A Real-Time Collaborative Whiteboard Web App built with NextJs.

Features

  • Share canvas in real-time easily just by sharing a link.
  • Chat with people in the room.
  • Own file extension .ink Save the drawing files locally on your device.

ScreenShots

image

This is a Next.js project bootstrapped with create-next-app.

Installation

  1. Clone the repository to your local machine.

    git clone https://github.com/himanshu8443/InkSync.git
  2. Install the required packages.

    cd InkSync
    npm install
    
    cd server
    npm install
  3. Set up the environment variables: Create a .env file in the root directory

    NEXT_PUBLIC_SERVER_URL= # URL of the server (e.g. http://localhost:3000 in development mode)

    Create a .env file in the server directory

    PORT = "5000"
  4. Start the development server.

    npm run dev

Open http://localhost:3000 with your browser to see the result.

You can start editing the page by modifying app/page.js. The page auto-updates as you edit the file.

This project uses next/font to automatically optimize and load Inter, a custom Google Font.

Learn More

To learn more about Next.js, take a look at the following resources:

You can check out the Next.js GitHub repository - your feedback and contributions are welcome!

Deploy on Vercel

The easiest way to deploy your Next.js app is to use the Vercel Platform from the creators of Next.js.

Check out our Next.js deployment documentation for more details.