This website is inspired by Notion and has been created solely for educational purposes. I hope you find something valuable to study in my project ❤️. If you have any questions or need assistance, please feel free to ask. Good luck with your learning journey!
Running follow these simple example steps below
- yarn
npm i yarn -g- Clone the repo
git clone https://github.com/ngoc2003/notion-clone.git- Create
.envfile in main path - Copy your env values like
.env.examplefile - Install packages
yarn install- Run backend application
npx convex dev- Run project
yarn dev- Open website in http://localhost:3000/
- Pull docker image
docker pull ngoc2003/notion-clone:latest- Run a Docker container
docker run -dp 127.0.0.1:3000:3000 ngoc2003/notion-clone- Navigate to https://127.0.0.1:3000
- Multi-language Support
- English
- Vietnamese
- Japanese
- Support edit from multiple users
- Rich text editor
- Tailwind design, animations and effects
- Responsive for all devices
- Google authentication
- Github authentication
- Real-time database
- Notion-style editor with blocknote
- Switch between Light and Dark mode
- Infinite children documents
- Trash list and soft delete 🗑️
- File modify
- Expandable, Collapsable sidebar
- Full mobile responsiveness
- Publish your note to the web
- Multiple languages
| Tools | Versions |
|---|---|
| yarn | 1.22.19 |
See full packages at Package.json
If you have a suggestion that would make this better, please fork the repo and create a pull request. Don't forget to give the project a star! Thanks again!
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature) - Commit your Changes (
git commit -m 'Add some AmazingFeature') - Push to the Branch (
git push origin feature/AmazingFeature) - Open a Pull Request
Distributed under the MIT License. See LICENSE for more information.
Bui Ngoc - Facebook