🎴 Sticky-Memo

Welcome to Sticky-Memo — a lightweight React app to create and manage digital sticky notes.
Built with React.ts, Vite, and TailwindCSS, this project is ideal for learning, experimenting, and contributing to open source. 🤍🤝

---

📚 Table of Contents

• About
• Demo
• Tech Stack
• Getting Started
• Project Structure
• Contribution Guide
• Development Standards
• Contributors
• License

---

📝 About

Sticky-Memo allows you to:

• Create, edit, and delete sticky notes
• Organize notes by boards, tables, and categories
• Practice React, Vite, and MUI
• Collaborate with a friendly open-source community

---

🌐 Demo

👉 Live Preview

---

🛠️ Tech Stack

• React.ts
• Vite
• TailwindCSS
• Typescript

---

🚀 Getting Started

1. Fork and Clone

git clone https://github.com/<your-username>/sticky-memo.git
cd sticky-memo

2. Install Dependencies

npm install

3. Run Locally

npm run dev

Open http://localhost:5173 in your browser.

---

📁 Project Structure

├── public/
│   └── favicon.svg
├── src/
│   ├── components/
│   │   ├── Board/
│   │   ├── common/
│   │   ├── Loading/
│   │   ├── Note/
│   │   └── Table/
│   ├── context/
│   ├── hooks/
│   ├── pages/
│   ├── services/
│   ├── styles/
│   ├── themes/
│   ├── utils/
│   ├── App.jsx
│   └── main.jsx
├── index.html
├── package.json
├── vite.config.js
└── README.md

---

🤝 Contribution Guide

We welcome contributions of all kinds — features, bug fixes, documentation, or ideas!

1. Fork the repo and create a branch from main or develop.
2. Make your changes and test locally.
3. Commit & push with a clear message:

git add .
git commit -m "feat: add new board component"
git push origin <your-branch>

4. Open a Pull Request and fill out the PR template.

Need help? Open an issue or join the discussions.

---

🧑‍💻 Development Standards

Code Style

• ESLint + Prettier for linting/formatting
• EditorConfig for consistent style
• 2-space indentation, max line length 100

Documentation

• Use JSDoc for functions and components
• Comment complex logic
• Keep README and docs updated

Git Workflow

• Feature branches: feature/short-description
• Bugfix branches: fix/short-description
• Follow Conventional Commits

Testing

• Maintain ≥80% coverage
• Test components in isolation
• Include positive and negative test cases

---

👥 Contributors

Thanks to all our amazing contributors! ❤️ View Contributors →

---

📜 License

This project is licensed under the MIT License. See the MIT-LICENSE.txt for details.

---

Happy Contributing! 🎉

```

---