Synkron: A Real-Time Notes App Like Notion

Welcome to the Synkron repository! Synkron Notes App is a cutting-edge SaaS platform designed to provide a powerful, collaborative, and private workspace for teams and individuals. Built with Next.js 14, Drizzle ORM, Socket.io, TypeScript, Supabase, PostgreSQL, and Shadcn UI, this app combines modern technologies to deliver an exceptional user experience. The app features real-time updates, custom email verification, a professional dashboard, and seamless integration with Stripe for payments.

Demo

Check out the live demo of Synkron here.

Preview

1. Landing Page

2. User Dashboard

Features

• Collaborative Workspaces: Create both collaborative and private workspaces.
• Folders and Files Management: Organize your notes with folders and files, all saved in real-time.
• Advanced Quill Editor: Enjoy a rich text editing experience with the best Quill editor.
• Real-Time Cursors: See real-time cursor movements of collaborators using Supabase real-time.
• Custom Email Verification: Secure your account with custom email verification via Supabase.
• User Profile Management: Update display name and profile picture with a modern custom dialog.
• Banner Upload/Update: Customize workspace appearance by uploading or updating banners.
• Settings and Trash Functionality: Manage settings and recover deleted items with ease.
• Stripe Payment Integration: Handle subscriptions and payments seamlessly using Stripe.
• Professional Dashboard: Navigate through a sleek and modern user interface.
• Supabase Authentication: Securely authenticate users with Supabase's authentication service.
• TypeScript and Drizzle ORM: Utilize TypeScript for type safety and Drizzle ORM for efficient database interactions.

Getting Started

To run the Synkron locally, follow these steps:

1. Clone the repository to your local machine:

   git clone https://github.com/Devsethi3/synkron.git

2. Navigate to the project directory:

   cd synkron

3. Install dependencies:

   npm install

4. Set up Supabase and PostgreSQL according to your environment.

5. Configure environment variables for Supabase, Stripe, and other services.

6. Start the development server:

   npm run dev

7. Open your web browser and visit http://localhost:3000 to use the app.

Usage

1. Landing Page: Get an overview of the platform and its features.
2. User Dashboard: Access your personal and team workspaces, organized with a 3D model for better visualization.
3. Create and Manage Workspaces: Set up new workspaces, folders, and files. Invite team members for collaboration.
4. Edit and Organize Notes: Use the Quill editor to create and format notes. Organize them within folders.
5. Real-Time Collaboration: See real-time cursor movements and updates from your team.
6. Profile Management: Update your profile information, including display name and profile picture.
7. Custom Email Verification: Ensure your account security with custom email verification.
8. Banner Management: Customize your workspace with banners.
9. Settings and Trash: Adjust settings and recover deleted items.
10. Subscription Management: Handle your subscription plans through Stripe integration.

Contributing

Contributions are welcome! If you'd like to contribute to this project, please follow these steps:

1. Fork the repository.
2. Create a new branch for your feature or bug fix.
3. Make your changes and commit them with descriptive messages.
4. Push your changes to your fork.
5. Open a pull request to merge your changes into the main branch.

Thank you for checking out the Synkron App repository. Start collaborating and organizing your notes with ease and efficiency!