Uotion is a Notion clone designed to streamline
workflow organization and note-taking.

---

📦 Installation

1. Clone the repository:

git clone https://github.com/Ukhang/uotion.git
cd uotion

2. Install the dependencies:

npm install

3. Set up the environment variables:
   Create a .env.local file in the root directory and add:

# Deployment used by `npx convex dev`
CONVEX_DEPLOYMENT=
NEXT_PUBLIC_CONVEX_URL=

NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY=
CLERK_SECRET_KEY=

EDGE_STORE_ACCESS_KEY=
EDGE_STORE_SECRET_KEY=

4. Run Convex:

npx convex dev

5. Run the development server:

npm run dev

Visit http://localhost:3000 to view the app in your browser.

Tech Stack

• Next.js - Framework for building React applications
• TypeScript - Strongly typed superset of JavaScript
• Tailwind CSS - Utility-first CSS framework for rapid UI development
• Convex - Backend-as-a-Service for real-time data management
• Clerk - User authentication and management solution
• Edge Store - Secure and scalable file storage system

Features

Productivity and Organization

• Notion-style editor for efficient note-taking
• Support for infinite nested documents to create hierarchical structures
• Expandable and collapsible sidebar for intuitive navigation
• Real-time customizable icons for each document
• Soft delete functionality with a trash bin and recovery options

User Experience

• Light and dark modes to match user preferences
• Fully responsive design optimized for mobile devices
• Dedicated landing page for an engaging entry point
• Personalizable cover images for individual documents

Data Management

• Real-time database updates for seamless data handling
• Options to upload, delete, and replace files effortlessly

Security and Sharing

• Secure user authentication to protect notes
• Ability to publish notes publicly for easy sharing

Contributing

1. Fork the repository
2. Create your feature branch (git checkout -b feature-name)
3. Commit your changes (git commit -m 'Add new feature')
4. Push to the branch (git push origin feature-name)
5. Open a pull request

License

This project is licensed under the MIT License.

🙌 Acknowledgements

• Inspired by Notion
• Thanks to the open-source community for continuous support

---

Made with ❤️ by Ukhang Marma