Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/somanshubhardwaj/notion-clone
This project is a clone of Notion, aiming to replicate some of the core features of the popular note-taking and organization tool. It's built using a modern tech stack including Next.js, React, Convex, and TailwindCSS, providing a rich, interactive user experience.
https://github.com/somanshubhardwaj/notion-clone
clerk convex nextjs notion react tailwindcss
Last synced: 25 days ago
JSON representation
This project is a clone of Notion, aiming to replicate some of the core features of the popular note-taking and organization tool. It's built using a modern tech stack including Next.js, React, Convex, and TailwindCSS, providing a rich, interactive user experience.
- Host: GitHub
- URL: https://github.com/somanshubhardwaj/notion-clone
- Owner: somanshubhardwaj
- License: mit
- Created: 2024-07-17T13:58:18.000Z (4 months ago)
- Default Branch: master
- Last Pushed: 2024-08-03T05:07:31.000Z (3 months ago)
- Last Synced: 2024-09-29T19:02:08.364Z (about 1 month ago)
- Topics: clerk, convex, nextjs, notion, react, tailwindcss
- Language: TypeScript
- Homepage: https://sotion-sand.vercel.app
- Size: 309 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Sotion - A Notion Clone
This project is a clone of Notion, aiming to replicate some of the core features of the popular note-taking and organization tool. It's built using a modern tech stack including Next.js, React, Convex, and TailwindCSS, providing a rich, interactive user experience.
## Features
- **Document Management**: Create, update, and delete documents with real-time updates.
- **Rich Text Editing**: Utilize a rich text editor for note-taking, including support for images, links, and more.
- **Authentication**: Secure user authentication with Clerk.
- **Responsive Design**: Fully responsive design that works on both desktop and mobile browsers.
- **Publish documents**: Share your documents with others by publishing them.
- **Add images , video and other type of files**
## Tech Stack
   
- **Next.js**: A React framework for production.
- **React**: A JavaScript library for building user interfaces.
- **Convex**: Backend for real-time web applications.
- **TailwindCSS**: A utility-first CSS framework for rapidly building custom designs.
- **Clerk**: For user authentication and management.
- **Lucide React**: Beautifully crafted open source icons.
- **Edgestore**:To store images and other files.
- **Typescript**: A typed superset of JavaScript that compiles to plain JavaScript.
## Getting Started
To get a local copy up and running follow these simple steps.
### Prerequisites
- npm
- Node.js v18 or higher
### Installation
1. Clone the repo
```sh
git clone https://github.com/somanshubhardwaj/notion-clone.git
```
2. Install NPM packages
```sh
npm install
```
3. Start the development server
```sh
npm run dev
```
4. Start the convex server
```sh
npx convex dev
```
## Usage
After starting the development server, you can create and manage your documents and explore the features modeled after Notion.
## 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**.
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
## Contact
Somanshu Bhardwaj - [@somanshubha](https://twitter.com/somanshubha)
Project Link: [https://github.com/somanshubhardwaj/notion-clone](https://github.com/somanshubhardwaj/notion-clone)