krniya / notion.io

A Notion clone is a web application that mimics the functionalities of the popular productivity tool, Notion. It includes features like note-taking, to-do lists, and collaborative workspaces.

Notion.io

project_description
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Contributing
5. License
6. Contact

About The Project

A Notion clone is a web application that mimics the functionalities of the popular productivity tool, Notion. It includes features like note-taking, to-do lists, and collaborative workspaces.

(back to top)

Built With

• 
• 

(back to top)

Getting Started

A Notion-like productivity app built with modern web technologies: Next.js, Supabase, Drizzle ORM, Socket.IO, Stripe, and Tailwind CSS.

Features

• Real-time collaboration
• Note-taking
• To-do lists
• User authentication
• Payment processing

Tech Stack

• Frontend: Next.js, Tailwind CSS
• Backend: Supabase, Drizzle ORM
• Real-time: Socket.IO
• Payments: Stripe

Prerequisites

• Node.js (>= 14.x)
• Next.js 14
• Supabase account
• Stripe account

• npm

  npm install npm@latest -g

Installation

1. Clone the repo

   git clone https://github.com/krniya/notion.io.git

2. Install NPM packages

   npm install

Environment Variables

Create a .env file in the root directory and add the following environment variables:

DATABASE_URL=
NEXT_PUBLIC_SUPABASE_URL=
NEXT_PUBLIC_SUPABASE_ANON_KEY=
SERVICE_ROLE_KEY=
PW=
NEXT_PUBLIC_SITE_URL=


NEXT_PUBLIC_STRIPE_PUBLISHABLE_KEY=
STRIPE_SECRET_KEY=
STRIPE_WEBHOOK_SECRET=

(back to top)

Usage

Once the development server is running, you can start using the Notion clone application. You can add, edit, and delete notes and to-do lists. Real-time collaboration is enabled through Socket.IO, and user authentication is handled by Supabase.

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

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

(back to top)

License

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

(back to top)

Contact

Nitish Yadav - @krniya_ - [e-mail]

Project Link: https://github.com/krniya/FunTick

(back to top)