Skip to content

Latest commit

 

History

History
75 lines (61 loc) · 2.48 KB

README.md

File metadata and controls

75 lines (61 loc) · 2.48 KB
Raw

notion-clone-nextjs

GitHub repo size GitHub stars GitHub forks


November, 2023.
A Notion Clone web application built with Next.js, React, Tailwind CSS, TypeScript, Convex, Clerk Auth, Edge Store, and Zustand.

Features

  • Create, edit, and organize notes in a Notion-like interface.
  • Real-time updates for editing using Convex.
  • User authentication and management with Clerk Auth.
  • File upload and storage using Edge Store.
  • Responsive design with Tailwind CSS.
  • State management using Zustand.

Getting Started

These instructions will help you set up and run the project on your local machine for development and testing purposes.

  1. Clone the repository:
git clone https://github.com/evanch98/notion-clone-nextjs.git
cd your-repo-name
  1. Install the required dependencies:
npm install
  1. Configure environment variables: Create a .env.local file in the project root and set the necessary environment variables.
CONVEX_DEPLOYMENT=
NEXT_PUBLIC_CONVEX_URL=

NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY=
CLERK_SECRET_KEY=

EDGE_STORE_ACCESS_KEY=
EDGE_STORE_SECRET_KEY=
  1. Run the development server:
npm run dev
  1. Start building and customizing your Notion Clone!

Technologies Used

Acknowledgements