DevPedroHB / notion-react

This project is a clone of Notion developed in React, which aims to reproduce some of the main features and appearance of the well-known productivity tool.

Notion React

This project is a clone of Notion developed in React, which aims to reproduce some of the main features and appearance of the well-known productivity tool.

Technologies  |   Services  |   Packages  |   Getting started  |   Features  |   Links  |   Versioning  |   License

🚀 Technologies

Here are the technologies used in this project.

• TypeScript 5.0.2
• NodeJS 18.14.2
• Vite 4.4.0
• TailwindCSS 3.3.3

📋 Services

Here are the services used in this project.

• GitHub
• Netlify

📦 Packages

Here are the production packages used in this project.

• @tiptap/react -> A modern text editing library offering a flexible and highly customizable editing experience based on a modular and extensible model.
• highlight.js -> Used to highlight code syntax in blocks of code within HTML pages.
• lowlight -> A JavaScript library used to highlight code syntax in blocks of code within HTML pages.
• react-icons -> Used to provide icons from many popular icon libraries in React applications.

💻 Getting started

Here are the commands and steps on how to start the project.

Dependency

• NodeJS
• NPM (Package manager of your choice)

Steps

# To install dependencies.
npm install

# To start the project on your machine.
npm run dev

# To build the project.
npm run build

# To run the project in production.
npm run start

# To format the 'src' folder code using eslint settings.
npm run lint

🔥 Features

Here are the main features of the project.

• Responsive design.
• Text styling, including bold, italics, headings, etc.

📎 Links

• Deploy on Netlify: https://notion-react.netlify.app/
• Repository: https://github.com/DevPedroHB/notion-react

🔰 Versioning

Here are the versions of the parts of the project.

• WEB -> 1.0.0

📝 License

This project is licensed under the MIT license.

---

Made with ♥ by Pedro Henrique 🚀 Never stop learning!