sepehr
8d95f34fcc
- Add debounced state updates for title and content (500ms delay) - Immediate UI updates with delayed history saving - Prevent one-letter-per-undo issue - Add cleanup for debounce timers on unmount
105 lines
3.3 KiB
Markdown
105 lines
3.3 KiB
Markdown
# Keep Notes - Google Keep Clone
|
|
|
|
A beautiful and feature-rich Google Keep clone built with modern web technologies.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
## ✨ Features
|
|
|
|
- 📝 **Create & Edit Notes**: Quick note creation with expandable input
|
|
- ☑️ **Checklist Support**: Create todo lists with checkable items
|
|
- 🎨 **Color Customization**: 10 beautiful color themes for organizing notes
|
|
- 📌 **Pin Notes**: Keep important notes at the top
|
|
- 📦 **Archive**: Archive notes you want to keep but don't need to see
|
|
- 🏷️ **Labels**: Organize notes with custom labels
|
|
- 🔍 **Real-time Search**: Instantly search through all your notes
|
|
- 🌓 **Dark Mode**: Beautiful dark theme with system preference detection
|
|
- 📱 **Fully Responsive**: Works perfectly on desktop, tablet, and mobile
|
|
- ⚡ **Server Actions**: Lightning-fast CRUD operations with Next.js 16
|
|
- 🎯 **Type-Safe**: Full TypeScript support throughout
|
|
|
|
## 🚀 Tech Stack
|
|
|
|
### Frontend
|
|
- **Next.js 16** - React framework with App Router
|
|
- **TypeScript** - Type safety and better DX
|
|
- **Tailwind CSS 4** - Utility-first CSS framework
|
|
- **shadcn/ui** - Beautiful, accessible UI components
|
|
- **Lucide React** - Modern icon library
|
|
|
|
### Backend
|
|
- **Next.js Server Actions** - Server-side mutations
|
|
- **Prisma ORM** - Type-safe database client
|
|
- **SQLite** - Lightweight database (easily switchable to PostgreSQL)
|
|
|
|
## 📦 Installation
|
|
|
|
### Prerequisites
|
|
- Node.js 18+
|
|
- npm or yarn
|
|
|
|
### Steps
|
|
|
|
1. **Clone the repository**
|
|
```bash
|
|
git clone <repository-url>
|
|
cd keep-notes
|
|
```
|
|
|
|
2. **Install dependencies**
|
|
```bash
|
|
npm install
|
|
```
|
|
|
|
3. **Set up the database**
|
|
```bash
|
|
npx prisma generate
|
|
npx prisma migrate dev
|
|
```
|
|
|
|
4. **Start the development server**
|
|
```bash
|
|
npm run dev
|
|
```
|
|
|
|
5. **Open your browser**
|
|
Navigate to [http://localhost:3000](http://localhost:3000)
|
|
|
|
## Getting Started
|
|
|
|
First, run the development server:
|
|
|
|
```bash
|
|
npm run dev
|
|
# or
|
|
yarn dev
|
|
# or
|
|
pnpm dev
|
|
# or
|
|
bun dev
|
|
```
|
|
|
|
Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
|
|
|
|
You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file.
|
|
|
|
This project uses [`next/font`](https://nextjs.org/docs/app/building-your-application/optimizing/fonts) to automatically optimize and load [Geist](https://vercel.com/font), a new font family for Vercel.
|
|
|
|
## Learn More
|
|
|
|
To learn more about Next.js, take a look at the following resources:
|
|
|
|
- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
|
|
- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.
|
|
|
|
You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js) - your feedback and contributions are welcome!
|
|
|
|
## Deploy on Vercel
|
|
|
|
The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js.
|
|
|
|
Check out our [Next.js deployment documentation](https://nextjs.org/docs/app/building-your-application/deploying) for more details.
|