Inkflow

Inkflow is an innovative whiteboard application designed for seamless collaboration and advanced visualizations. It leverages Convex, Lerk, TypeScript, Next.js, Shacdn and Tailwind CSS, to provide a rich user experience.

Features

• Whiteboard Drawing: Create and customize diagrams, flowcharts, and sketches effortlessly.
• Convex Integration: Utilize Convex as a real time database.
• Clerk Support: Use clerk for user auth.
• TypeScript Powered: Enhance code quality and maintainability with TypeScript's strong typing.
• Next.js Framework: Benefit from server-side rendering, routing, and API integration provided by Next.js.
• Shacdn Styling: Utilize Shacdn's responsive design and utility classes for a modern UI.
• Tailwind CSS: Customize the look and feel of Inkflow with Tailwind CSS's utility-first approach.

Installation

To install and run Inkflow locally, follow these steps:

1. Clone the repository:

   git clone https://github.com/your-username/inkflow.git

2. Install dependencies:

   cd inkflow
   npm install

3. Create .env file and paste your environment keys:

4. Start the development server:

   npm run dev

5. Start the convex server:

   npx convex dev

6. Open your browser and navigate to http://localhost:3000 to access Inkflow.

Collaborative Features (Coming Soon)

Inkflow's collaborative features enable teams to work together efficiently:

• Real-time Updates: Changes made by one user are instantly reflected across all connected devices.
• Chat Integration: Communicate with team members using the built-in chat functionality.
• User Cursors: See where collaborators are working on the canvas with real-time cursor positions.

Templates (Coming Soon)

We're actively working on adding template support to Inkflow. Stay tuned for a variety of pre-designed templates for common use cases such as:

• Mind Maps
• User Interface Mockups
• Network Diagrams
• Project Timelines
• And more!

Contributing

We welcome contributions from the community! If you'd like to contribute to Inkflow, please follow these guidelines:

1. Fork the repository.
2. Make your changes.
3. Submit a pull request with a clear description of your changes.

License

This project is licensed under the MIT License