Skip to content

NotesHub πŸ“ - A sleek and intuitive note-taking app to organize your thoughts, ideas, and tasks effortlessly. πŸ”— Live Demo Available 🌐

License

Notifications You must be signed in to change notification settings

AlokKumarYadav2410/notes-hub

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

10 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

πŸ“ NotesHub - Your Personal Note-Taking Companion

Welcome to NotesHub! πŸŽ‰ NotesHub is a sleek and intuitive note-taking application designed to help you organize your thoughts, ideas, and tasks effortlessly. Whether you're jotting down quick notes or creating detailed plans, NotesHub has got you covered! πŸš€


πŸ“š Table of Contents


🎨 Screenshots

🏠 Home Page

Home Page

πŸ“ Notes Page

Notes Page


🌐 Live Demo

Check out the live demo here: πŸ”— NotesHub Live Demo 🌍


🌟 Features

✨ Create Notes: Quickly jot down your ideas and thoughts.
πŸ” Search Notes: Easily find notes using the search functionality.
✏️ Edit Notes: Update your notes as your ideas evolve.
πŸ—‘οΈ Delete Notes: Remove notes you no longer need.
πŸ“Š Organized View: View all your notes in a clean and structured layout.
πŸ”— Share Notes: Generate shareable links for your notes.
πŸ’Ύ Persistent Storage: Your notes are saved in your browser's local storage, so they won't disappear on refresh!
πŸ“± Responsive Design: Fully adaptive for mobile, tablet, and desktop devices, ensuring a seamless experience on any screen size.


πŸ–₯️ Tech Stack

  • Frontend: React βš›οΈ
  • State Management: Redux Toolkit πŸ› οΈ
  • Styling: TailwindCSS 🎨
  • Routing: React Router 🌐
  • Notifications: React Hot Toast πŸ””
  • Build Tool: Vite ⚑

πŸš€ Getting Started

Follow these steps to run NotesHub on your local machine:

1️⃣ Clone the Repository

git clone https://github.com/AlokKumarYadav2410/notes-hub.git
cd notes-hub

2️⃣ Install Dependencies

npm install

3️⃣ Install Tailwind CSS

npm install tailwindcss @tailwindcss/vite

4️⃣ Install React Redux

npm i react-redux

5️⃣ Install React-Router-DOM

npm i react-router-dom

6️⃣ Toast Notifications

npm install react-hot-toast

7️⃣ Start the Development Server

npm run dev

8️⃣ Open in Browser

Visit http://localhost:5173 to see GitPDF in action! πŸŽ‰
or
http://localhost:5174

πŸ“‚ Project Structure

notes-hub/
β”œβ”€β”€ public/               # Static assets
β”œβ”€β”€ src/
β”‚   β”œβ”€β”€ components/       # Reusable components (Navbar, Footer, Note, etc.)
β”‚   β”œβ”€β”€ redux/            # Redux slices for state management
β”‚   β”œβ”€β”€ App.jsx           # Main application file
β”‚   β”œβ”€β”€ index.css         # Global styles
β”‚   β”œβ”€β”€ main.jsx          # Entry point
β”œβ”€β”€ package.json          # Project dependencies and scripts
└── README.md             # Project documentation

🀝 Contributing

We welcome contributions! πŸ› οΈ If you'd like to improve NotesHub, follow these steps:

  1. Fork the repository.
  2. Create a new branch: git checkout -b feature-name.
  3. Make your changes and commit them: git commit -m "Add feature-name".
  4. Push to your branch: git push origin feature-name.
  5. Open a pull request.

πŸ“œ License

  • This project is licensed under the MIT License. See the LICENSE file for details.

❀️ Acknowledgments

  • Built with love by Alok Kumar Yadav.
  • Inspired by the need for simple and effective note management.

🌐 Connect with Me


NotesHub: Simplify your life, one note at a time! ✨

About

NotesHub πŸ“ - A sleek and intuitive note-taking app to organize your thoughts, ideas, and tasks effortlessly. πŸ”— Live Demo Available 🌐

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published