NoteScape

AI-powered note-taking application with real-time collaboration capabilities.

Demo • Report Bug • Request Feature

✨ Features

• Real-time Collaboration: Work together with live cursors and text selection powered by Liveblocks
• AI Integration: Leverages Meta's Llama model for intelligent features
  • Smart note translation
  • Context-aware question answering
  • Intelligent summarization
• Rich Editor: BlockNote-powered editor with smooth animations and formatting
• Image Support: Seamless media integration with EdgeStore
• Secure Authentication: User management through Clerk
• Edge Computing: Fast AI processing with Cloudflare Workers

🚀 Tech Stack

• Frontend

  • Next.js 14
  • TypeScript
  • TailwindCSS
  • shadcn/ui components
  • BlockNote Editor

• Backend & Infrastructure

  • Cloudflare Workers (Edge Computing)
  • Meta's Llama Model (AI Processing)
  • Liveblocks (Real-time Collaboration)
  • EdgeStore (Image Storage)
  • Clerk (Authentication)
  • Firebase (Database)

🛠 Installation

1. Clone the repository:

git clone https://github.com/maheshpaulj/NoteScape-2.0.git
cd notescape

2. Install dependencies:

npm install

3. Set up environment variables:

cp .env.example .env.local

4. Configure your environment variables in .env.local:

NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY=
CLERK_SECRET_KEY=

NEXT_PUBLIC_LIVEBLOCKS_PUBLIC_KEY=
LIVEBLOCKS_PRIVATE_KEY=
EDGE_STORE_ACCESS_KEY=
EDGE_STORE_SECRET_KEY=

NEXT_PUBLIC_BASE_URL=

FIREBASE_SERVICE_KEY
FIREBASE_KEY=

5. Run the development server:

npm run dev

Visit http://localhost:5000 to see your local instance.

📝 Usage

Watch a Demo video

🤝 Contributing

Contributions are welcome! Please feel free to submit a Pull Request. For major changes, please open an issue first to discuss what you would like to change.

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

This project is licensed under the MIT License - see the LICENSE file for details.

🙏 Acknowledgments

• BlockNote for the amazing editor
• Liveblocks for real-time collaboration features
• EdgeStore for image storage solutions
• Clerk for authentication
• shadcn/ui for beautiful UI components

📱 Roadmap

• Enhanced mobile experience
• Offline support
• More AI-powered features
• Customizable Home page