Skip to content

Latest commit

 

History

History
170 lines (120 loc) · 4.6 KB

README.md

File metadata and controls

170 lines (120 loc) · 4.6 KB
Raw

Contributors Forks Stargazers Issues

About The Project

Notion Clone

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!

Built With

Next Tailwindcss Typescript Docker Vercel RadixUI

Getting Started

Running follow these simple example steps below

Prerequisites

  • yarn
  npm i yarn -g

Installation

  1. Clone the repo
  git clone https://github.com/ngoc2003/notion-clone.git
  1. Create .env file in main path
  2. Copy your env values like .env.example file
  3. Install packages
  yarn install
  1. Run backend application
  npx convex dev
  1. Run project
  yarn dev
  1. Open website in http://localhost:3000/

Run application with Docker

  1. Pull docker image
  docker pull ngoc2003/notion-clone:latest
  1. Run a Docker container
  docker run -dp 127.0.0.1:3000:3000 ngoc2003/notion-clone
  1. Navigate to https://127.0.0.1:3000

Roadmap

  • Multi-language Support
    • English
    • Vietnamese
    • Japanese
  • Support edit from multiple users
  • Rich text editor

Features

  • 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

Tools Versions
yarn 1.22.19

Packages

See full packages at Package.json

Contributing

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!

  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

License

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

Contact

Bui Ngoc - Facebook