Skip to content

README.md

Latest commit

 

History

History
82 lines (61 loc) · 2.38 KB

README.md

File metadata and controls

82 lines (61 loc) · 2.38 KB

📝 Notefy

A minimalistic note-taking web app with authentication, rate limiting, and a modern UI.
🌍 Live Demo

📸 Screenshots

image image image image image image image

✨ Features

  • 🔐 Authentication

    • Google OAuth 2.0 Sign-In
    • JWT Token-based session handling

  • 📖 Manage Your Notes

    • Create, Read, Update, and Delete notes
    • MongoDB backend with Mongoose

  • ⚡ Rate Limiting (per user)

    • Implemented with Upstash Redis
    • Prevents abuse by limiting excessive requests

  • 🎨 Modern UI/UX

    • Built with React + Vite
    • Styled using TailwindCSS + DaisyUI
    • Toast notifications using react-hot-toast

  • 🌐 Backend API

    • Built with Node.js + Express
    • Endpoints:
      • POST /auth/google → Login
      • GET /notes → Fetch notes
      • POST /notes → Create note
      • PUT /notes/:id → Update note
      • DELETE /notes/:id → Delete note

🛠️ Tech Stack

Frontend

  • React (Vite)
  • TailwindCSS + DaisyUI
  • React Router
  • Axios
  • React Hot Toast

Backend

  • Node.js
  • Express.js
  • MongoDB + Mongoose
  • JWT Authentication
  • Upstash Redis (Rate Limiting)

⚙️ Installation & Setup

  1. Clone the repo 
    git clone https://github.com/yourusername/notefy.git
cd notefy
  2. Build the application 
    npm run build
  3. Run the server 
    npm run start