Skip to content

cihad/ai-generated-note-app

Repository files navigation

Cursor Note App

A modern, feature-rich note-taking application built with React, TypeScript, and Vite. This application provides a clean and intuitive interface for creating, managing, and organizing your notes.

Features

  • 📝 Create and edit rich text notes with formatting options
  • 📋 Organize notes with titles and timestamps
  • ⭐ Favorite important notes for quick access
  • 💾 Automatic saving of notes
  • 🎨 Clean and modern user interface
  • ⌨️ Keyboard shortcuts for common actions
  • 📱 Responsive design that works on all devices

Text Formatting Options

  • Bold, italic, and strikethrough text
  • Multiple heading levels (H1, H2, H3)
  • Bullet and numbered lists
  • Code blocks
  • And more...

Project Structure

cursor-note-app/
├── src/
│   ├── components/     # React components
│   ├── hooks/         # Custom React hooks
│   ├── types/         # TypeScript type definitions
│   ├── utils/         # Utility functions
│   ├── App.tsx        # Main application component
│   └── main.tsx       # Application entry point
├── public/            # Static assets
├── index.html         # HTML template
├── package.json       # Project dependencies and scripts
├── tsconfig.json      # TypeScript configuration
├── vite.config.ts     # Vite configuration
└── tailwind.config.js # Tailwind CSS configuration

Getting Started

  1. Clone the repository:
git clone https://github.com/cihad/cursor-note-app.git
cd cursor-note-app
  1. Install dependencies using pnpm:
pnpm install
  1. Start the development server:
pnpm dev
  1. Open your browser and navigate to http://localhost:5173

Available Scripts

  • pnpm dev - Start the development server
  • pnpm build - Build the application for production
  • pnpm preview - Preview the production build locally
  • pnpm lint - Run ESLint to check code quality
  • pnpm format - Format code using Prettier

Dependencies

  • React 18
  • TypeScript 5
  • Vite 5
  • TipTap Editor
  • Tailwind CSS
  • ESLint
  • Prettier
  • And more...

Contributing

  1. Fork the repository
  2. Create your feature branch (git checkout -b feature/amazing-feature)
  3. Commit your changes (git commit -m 'Add some amazing feature')
  4. Push to the branch (git push origin feature/amazing-feature)
  5. Open a Pull Request

License

This project is licensed under the MIT License.