🎯 Scratchpad Scribe

A modern, minimal, and collaborative note-taking web application built with React, TypeScript, Vite, Tailwind CSS, and shadcn/ui — designed for speed, simplicity, and seamless writing.

---

🚀 Project Overview

Scratchpad Scribe is a lightweight and responsive notes application that lets you jot down, organize, and manage your thoughts effortlessly.
With its clean UI and fast performance, it’s perfect for developers, students, and creators alike.

✨ Key Features

• 📝 Create, edit, and delete notes in real time
• 🌙 Responsive and dark-mode-friendly interface
• ⚡ Built with modern technologies (React + Vite + TypeScript)
• 💾 Persistent storage and seamless user experience
• 🔔 Toast notifications and smooth transitions
• 📎 Attach files, images, and documents to notes (local, private)

---

🧩 Tech Stack

Technology	Description
⚡ Vite	Lightning-fast build tool for modern web apps
⚛️ React	UI library for building interactive interfaces
💅 Tailwind CSS	Utility-first CSS framework for rapid styling
🧱 shadcn/ui	Beautifully designed UI components
🧠 TypeScript	Type-safe JavaScript for better scalability

---

Edit a file directly in GitHub

• Navigate to the desired file(s).
• Click the "Edit" button (pencil icon) at the top right of the file view.
• Make your changes and commit the changes.

Use GitHub Codespaces

• Navigate to the main page of your repository.
• Click on the "Code" button (green button) near the top right.
• Select the "Codespaces" tab.
• Click on "New codespace" to launch a new Codespace environment.
• Edit files directly within the Codespace and commit and push your changes once you're done.

---

⚙️ Setup Instructions

Follow these steps to get the project running locally:

# Step 1: Clone the repository
git clone https://github.com/DhanushNehru/scratchpad-scribe.git

# Step 2: Navigate to the project directory
cd scratchpad-scribe

# Step 3: Install dependencies
npm install

# Step 4: Start the development server
npm run dev

📎 Attachments

• Add files from the editor: open a note, scroll to the Attachments section, and click "Add files".
• Files are stored in your browser using IndexedDB; only lightweight metadata is saved with the note in localStorage.
• Max file size per attachment is ~25MB. Duplicating a note does not copy attachments.
• Removing site data will delete stored attachments.

💡 How to Contribute

We ❤️ contributions from the community!
If you’re participating in Hacktoberfest 2025, this is a great place to start! 🌱

Follow the steps below to contribute:

Steps to Contribute

1. Fork the repository.

2. Clone your forked repository using the command:

   git clone https://github.com/your-username/scratchpad-scribe.git

3. Navigate into the project directory:

   cd scratchpad-scribe

4. Create a new branch for your feature or fix:

   git checkout -b feature/your-feature-name

5. Make your changes — improve docs, fix bugs, or add new features.

6. Stage and commit your changes:

   git add .
   git commit -m "Added a new feature: your-feature-name"

7. Push your branch to your forked repository:

   git push origin feature/your-feature-name

8. Open a Pull Request (PR) to the main repository:

   • Go to the original repo on GitHub.
   • Click “Compare & Pull Request.”
   • Add a clear title and description for your PR.
   • Submit it for review 🚀

---

🧩 Contribution Tips

• Make sure your code follows the project’s structure and style.
• Keep PRs focused — one feature or fix per PR.
• Add screenshots or demo GIFs if your change affects the UI.
• Be respectful and collaborative in discussions 💬

---

🌸 Hacktoberfest 2025 Note

This repository is part of Hacktoberfest 2025!
Your contributions here count towards your official Hacktoberfest goals.
So fork the repo, start contributing, and earn your swag! 🎉

Need Help? Join Our Community

Looking for real-time support, merge help, or just want to chat with other contributors?
Come hang out with us on Discord and get connected instantly!