https://github.com/underprotectiondev/ai-notes-app
https://github.com/underprotectiondev/ai-notes-app
Last synced: 9 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/underprotectiondev/ai-notes-app
- Owner: UnderprotectionDev
- Created: 2025-06-25T17:18:08.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2025-06-27T15:47:50.000Z (11 months ago)
- Last Synced: 2025-07-29T01:04:01.506Z (10 months ago)
- Language: TypeScript
- Homepage: https://not-ai-notes-app.vercel.app
- Size: 725 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
AI-Powered Notes 📝
An intelligent note-taking application powered by AI. Built with Next.js 15 and Convex, featuring AI-powered chatbot and RAG (Retrieval-Augmented Generation) technology to make your notes smarter.
[](https://nextjs.org/)
[](https://reactjs.org/)
[](https://www.typescriptlang.org/)
[](https://convex.dev/)
[](https://github.com/vercel/ai)
[](https://openai.com/)
[](https://tailwindcss.com/)
[](https://ui.shadcn.com/)
[](https://react-hook-form.com/)
[](https://zod.dev/)
[](https://vercel.com/)
## ✨ Features
| Feature | Description |
| ---------------------- | ------------------------------------------------------------------ |
| 🔐 User Authentication | Secure authentication system powered by Convex Auth. |
| 📝 Smart Note Creation | AI-assisted note creation and editing capabilities. |
| 🤖 AI Chatbot | Intelligent chatbot to interact with your notes and ask questions. |
| 🔍 RAG Technology | Enhanced AI responses with Retrieval-Augmented Generation. |
| 📋 Note Management | Organize and manage your notes efficiently. |
| 🎨 Modern UI | Modern and responsive design with Shadcn/ui components. |
| 🌙 Dark Mode | Dark/light mode support for better user experience. |
| ⚡️ Real-time Updates | Real-time data synchronization powered by Convex. |
| 📱 Responsive Design | Perfect user experience across all devices. |
| 🔧 Type Safety | End-to-end TypeScript support for better development. |
| 📊 Advanced Search | AI-powered advanced search capabilities. |
| 🎯 Markdown Support | Write and view notes in Markdown format. |
## 🌟 Tech Highlights
- **Next.js 15** with modern React 19 support and Turbopack
- **Convex** for serverless backend and real-time database
- **TypeScript** for complete type safety
- **AI SDK** with OpenAI integration and streaming responses
- **RAG Technology** for enhanced AI responses
- **Convex Auth** for secure authentication
- **Shadcn/ui** components for modern UI
- **Tailwind CSS** for responsive design
- **React Hook Form** for managing forms with ease
- **Zod** for generating typesafe forms with minimal boilerplate
## 🚀 Quick Start
```bash
# Clone the repository
git clone https://github.com/yourusername/ai-notes.git
cd ai-notes
# Install dependencies
npm install
# Create environment variables file
cp .env.example .env.local
# Set up Convex
npx convex dev
# Start the development server
npm run dev
```
Visit [http://localhost:3000](http://localhost:3000) to use the application.
## 🛠️ Tech Stack
Click to expand tech stack details
### Core Framework & Libraries
- **[Next.js 15](https://nextjs.org/)** - React framework with App Router and Turbopack
- **[React 19](https://reactjs.org/)** - Latest React with concurrent features
- **[TypeScript](https://www.typescriptlang.org/)** - Type-safe JavaScript
- **[Zod](https://zod.dev/)** - TypeScript-first schema validation
- **[React Hook Form](https://react-hook-form.com/)** - Performant form handling
- **[React Markdown](https://github.com/remarkjs/react-markdown)** - Markdown rendering
### AI & Backend
- **[Convex](https://convex.dev/)** - Serverless backend with real-time database
- **[Convex Auth](https://docs.convex.dev/auth)** - Authentication solution
- **[AI SDK](https://sdk.vercel.ai/)** - AI integration toolkit
- **[OpenAI](https://openai.com/)** - GPT models for AI features
- **RAG Technology** - Retrieval-Augmented Generation for enhanced AI responses
### UI & Styling
- **[Tailwind CSS](https://tailwindcss.com/)** - Utility-first CSS framework
- **[Shadcn/ui](https://ui.shadcn.com/)** - Re-usable components with Radix UI
- **[Lucide React](https://lucide.dev/)** - Beautiful icon library
- **[Next Themes](https://github.com/pacocoursey/next-themes)** - Theme management
### Development Tools
- **[ESLint](https://eslint.org/)** - Code linting
- **[Tailwind Typography](https://tailwindcss.com/docs/typography-plugin)** - Beautiful typography
## 📸 Screenshots
### 📋 Notes Dashboard
### ✍️ Note Creation
### 👁️ Note Viewer
### 🤖 AI Chatbot
## 🔐 Environment Variables
Create a `.env.local` file in the root of your project:
```env
# Convex
CONVEX_DEPLOY_KEY=
NEXT_PUBLIC_CONVEX_URL=
# Authentication (Convex Auth)
JWKS=
JWT_PRIVATE_KEY=
# OpenAI
OPENAI_API_KEY=
# Application
NEXT_PUBLIC_BASE_URL=http://localhost:3000
```
| Variable | Description | Required |
| ------------------------ | ----------------------------------- | -------- |
| `CONVEX_DEPLOY_KEY` | Convex deployment identifier | ✅ |
| `NEXT_PUBLIC_CONVEX_URL` | Public Convex URL | ✅ |
| `JWKS` | JSON Web Key Set for authentication | ✅ |
| `JWT_PRIVATE_KEY` | Private key for JWT token signing | ✅ |
| `OPENAI_API_KEY` | OpenAI API key for AI features | ✅ |
| `NEXT_PUBLIC_BASE_URL` | Public URL of your application | ✅ |
## 🎯 Key Features Explained
### 🤖 AI-Powered Chatbot
- Interact with your notes intelligently
- Enhanced responses with RAG technology
- Fast interaction with streaming responses
### 📝 Smart Note Management
- Rich text editor with Markdown support
- Real-time collaboration features
- Auto-save functionality
### 🔍 Advanced Search
- AI-powered search algorithms
- Semantic search capabilities
- Quick filtering and sorting