/scribe-sync

A notion clone built with NextJs and Convex, with dynamic page layout and optimized build.

Primary LanguageTypeScriptMIT LicenseMIT

ScribeSync

ScribeSync, powered by Next.js and Vercel, is the ultimate platform for seamless note-taking and collaborative work. Experience unparalleled speed, security, and performance while managing your ideas and projects effortlessly.

ScribeSync_screenshot

Table of Contents
  1. About The Project
  2. Getting Started
  3. Features
  4. Contributing
  5. License
  6. View Demo
  7. Contact

Built With

Getting Started

Prerequisites

Install Nodejs from the official site. Create account in Convex and EdgeStore to get started with the api for backend.

Installation

Follow the following steps to install and setup the virtual environment.

  1. Clone the repo 
    git clone https://github.com/Samrat-14/scribe-sync.git
  2. Once inside the cloned repo, get started with installing the node modules. 
    npm install
  3. Start the server for frontend. 
    npm run dev
  4. Start the server for backend. 
    npm convex dev
  5. After the installments are over and the server is running, you can get started with the project.

Features

  • Effortlessly manage and structure your notes, documents, and tasks with a versatile organizational system, allowing for customizable layouts and categorization.
  • Facilitate seamless teamwork with real-time editing, enabling multiple users to view shared documents simultaneously, fostering efficient communication and productivity.
  • Enhance your notes with multimedia elements, including images to create engaging and dynamic content that captures ideas in various formats.
  • Choose from a diverse range of customizable templates tailored for different use cases, ensuring quick and efficient initiation of projects, tasks, and workflows to suit individual preferences and requirements.
  • Access ScribeSync from various devices and operating systems, ensuring that your notes and data are synchronized across multiple platforms, allowing for convenient and on-the-go access to your information.

Contributing

I love contributions, so please feel free to fix bugs, improve things, provide documentation. If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

View Demo

Live Demo: https://samrat-scribesync.vercel.app/

Contact

Your Name - Samrat Sadhu - ss2414@ece.jgec.ac.in