Nick-h4ck3r / quickflow

This repository is dedicated to Quickflow, an open-source alternative to Notion that aims to provide a superior user experience.

Quickflow: A Better & Open-Source Alternative to Notion

This repository is dedicated to Quickflow, an open-source alternative to Notion that aims to provide a superior user experience.

Technologies used to build

• Next.js 13: A powerful React framework for building modern web applications.
• Shadcn: Beautifully designed components that you can copy and paste into your apps.
• Clerk: Clerk is a complete suite of embeddable UIs, flexible APIs, and admin dashboards to authenticate and manage your users.
• Convex: Convex is a Backend Application Platform that keeps you focused on building your product. Convex Functions, Database, File Storage, Scheduling, and Search fit together cohesively
• TailwindCSS: A utility-first CSS framework for streamlined web application styling.

Key Features

• Real-time database 🔗
• Notion-style editor 📝
• Light and Dark mode 🌓
• Infinite children documents 🌲
• Trash can & soft delete 🗑️
• Authentication 🔐
• File upload
• File deletion
• File replacement
• Icons for each document (changes in real-time) 🌠
• Expandable sidebar ➡️🔀⬅️
• Full mobile responsiveness 📱
• Publish your note to the web 🌐
• Fully collapsable sidebar ↕️
• Landing page 🛬
• Cover image of each document 🖼️
• Recover deleted files 🔄📄

Setting Up the Project in Local

Prerequisites

Ensure that you have Node version 18.x.x or a higher version installed.

Cloning the repository

git clone https://github.com/Nick-h4ck3r/quickflow.git

Install packages

npm i

Setup .env file

# Deployment used by `npx convex dev`
CONVEX_DEPLOYMENT=
NEXT_PUBLIC_CONVEX_URL=

NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY=
CLERK_SECRET_KEY=

EDGE_STORE_ACCESS_KEY=
EDGE_STORE_SECRET_KEY=

Setup Convex

npx convex dev

Start the app

npm run dev

Credits

Special thanks to Antonio for his invaluable tutorial, which served as the foundation for building this app. You can find the tutorial here.