Skip to content

Latest commit

 

History

History
140 lines (85 loc) · 3.65 KB

README.md

File metadata and controls

140 lines (85 loc) · 3.65 KB
Raw

Notion Clone

Welcome to the Notion Clone project! This is an open-source project aiming to replicate the core functionalities of Notion, using modern web development technologies such as Next.js, TypeScript, Tailwind CSS, and Supabase.

Deploy

GitHub Repo

Notion Clone Preview

Features

✨ Dynamic Page Creation: Create and manage pages dynamically, similar to Notion.
📝 Rich Text Editor: Edit content with a rich text editor.
🗄️ Database Integration: Utilize Supabase for backend database services.
📱 Responsive Design: Mobile-friendly UI built with Tailwind CSS.
🔐 Authentication: Secure user authentication with Supabase Auth.
🤝 Real-time Collaboration: Collaborate in real-time on pages.

Features Preview

Recording.2024-07-28.201242.mp4

generate content using AI

AI.mp4

Technologies Used

  • Next.js: A React framework for server-side rendering and static site generation.
  • TypeScript: A statically typed superset of JavaScript.
  • Tailwind CSS: A utility-first CSS framework for rapid UI development.
  • Supabase: An open-source Firebase alternative providing database and authentication services.

Getting Started

Prerequisites

Make sure you have the following installed on your machine:

  • Node.js (>=14.x)
  • npm or yarn
  • Supabase account and project setup

Installation

  1. Clone the repository:

    git clone https://github.com/alok-mishra143/notionV2.git
cd notionV2

  2. Install dependencies:

    Using npm:

    npm install

    Or using yarn:

    yarn install

  3. Setup environment variables:

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

    DATABASE_URL=your-database-url
NEXT_PUBLIC_SUPABASE_URL=your-supabase-url
NEXT_PUBLIC_SUPABASE_ANON_KEY=your-supabase-anon-key
SERVICE_ROLE_KEY=your-service-role-key
PW=your-password
NEXT_PUBLIC_SITE_URL=http://localhost:3000/

    Replace the placeholder values with your actual Supabase project details.

Running the Project

Start the development server:

Using npm:

npm run dev

Or using yarn:

yarn dev

Open your browser and navigate to http://localhost:3000 to see the application running.

Contributing

We welcome contributions! Follow these steps to contribute:

  1. Fork the repository.
  2. Create a new branch (git checkout -b feature/your-feature-name).
  3. Make your changes.
  4. Commit your changes (git commit -m 'Add some feature').
  5. Push to the branch (git push origin feature/your-feature-name).
  6. Open a pull request.

Please ensure your code adheres to our coding standards and passes all tests.

License

This project is licensed under the MIT License. See the LICENSE file for details.

Acknowledgements

If you have any questions or need further assistance, please open an issue or reach out to us.

Happy coding! 🚀