Skip to content

Saganaki22/Clarity

Repository files navigation

Clarity - A Notion-inspired Workspace

Clarity is a modern, open-source note-taking and workspace application inspired by Notion. It provides a clean and intuitive interface for organizing your thoughts, notes, and projects.

image

Features

  • 📝 Rich text editing with markdown support
  • 📚 Hierarchical page organization
  • 🌙 Light and dark mode
  • 📱 Responsive design for desktop and mobile
  • 🔄 Local storage persistence
  • ⚡ Fast and lightweight

Technology Stack

  • Next.js 15
  • React 19
  • TypeScript
  • Tailwind CSS
  • Radix UI Components
  • Local Storage for data persistence

Getting Started

Prerequisites

  • Node.js 18.0 or higher
  • npm or pnpm

Installation

  1. Clone the repository

    git clone https://github.com/yourusername/clarity-notion-clone.git
    cd clarity-notion-clone
  2. Install dependencies

    npm install
    # or
    pnpm install
  3. Start the development server

    npm run dev
    # or
    pnpm dev
  4. Open your browser and navigate to http://localhost:3000

Building for Production

npm run build
# or
pnpm build

To start the production server:

npm start
# or
pnpm start

Customization

Clarity is built to be customizable. You can modify the theme, add new components, or extend functionality by editing the source code.

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

License

This project is licensed under the Apache License 2.0 - see below for details:

Copyright 2023 Clarity

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

Acknowledgments

About

Clarity is a modern, open-source note-taking and workspace application inspired by Notion

Resources

License

Stars

Watchers

Forks

Contributors