Skip to content

imohammedh/Notevo

Repository files navigation

Notevo

Notevo is an AI-powered, real-time note-taking SaaS platform designed to help users create, edit, and organize their notes seamlessly. With a Notion-style WYSIWYG editor, users can enjoy a rich-text editing experience and leverage AI to improve productivity through intelligent suggestions and auto-completion.

Home Page

if you wanna contribute here => To Do :

  • fix the routing
  • Link and fix the AI API
  • add the toaster notification
  • add Onboarding Flow
  • fix the middleware 404 on redirect
  • fix the Tooltip from @heroui and change the close time ciz it causes conflict in the sidebar
  • add the shareable Link
  • fix the code Highlight in the editer
  • add the feedback menu item in the user dropdown menu in the sidebar
  • complete the ui for theuser account and settings
  • Redesigning for the dashboard
  • fix the caching
  • change the rename stff in the workingspace route

Features

  • 📝 Notion-style editor powered by Novel
  • 🤖 AI-powered autocompletion with OpenAI integration
  • 🔄 Real-time updates
  • 📂 Cloud storage support with Convex
  • 🔐 Authentication with Convex
  • 🚀 Optimized performance with Convex
  • 🌍 Deployed on Vercel for seamless access

Tech Stack

  • Frontend: Next.js, React, TypeScript, Tailwind CSS
  • Backend: Convex
  • AI Integration: OpenAI API, Vercel AI SDK
  • Editor: Tiptap (Novel)
  • Deployment: Vercel

Getting Started

Prerequisites

Make sure you have the following installed:

  • Node.js 18+
  • Convex CLI (for backend development)
  • Vercel CLI (optional, for deployment)

Installation

git clone https://github.com/imohammedh/Notevo.git
cd Notevo
pnpm install  # or npm install

Environment Variables

Create a .env file and add the following:

CONVEX_DEPLOY_KEY=your_convex_deploy_key
OPENAI_API_KEY=your_openai_key

Running Locally

pnpm dev  # or npm run dev

Then, open http://localhost:3000 in your browser.

Contributing

We appreciate contributions to Notevo! Follow these steps to contribute:

  1. Fork the Repository

    • Click the 'Fork' button at the top right of the repository page on GitHub.
  2. Clone Your Fork

    git clone https://github.com/your-username/Notevo.git
    cd Notevo
  3. Create a New Branch

    git checkout -b feature-name
  4. Make Changes

    • Implement your feature or fix the bug.
    • Commit your changes with a descriptive message.
    git commit -m "Add feature XYZ"
  5. Push Your Branch

    git push origin feature-name
  6. Submit a Pull Request

    • Go to the original repository on GitHub.
    • Click 'New Pull Request' and select your branch.
    • Provide a clear description of your changes.
    • Submit the pull request for review.

We will review your PR and provide feedback as needed. Thanks for contributing! 🚀

About

Notevo is an AI-powered, real-time note-taking SaaS platform . 🤖✨

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •