ShelfShare GitHub Repository

Welcome to the ShelfShare GitHub repository! 🎉 ShelfShare is a collaborative platform that transforms reading into a community-driven experience. Whether you want to annotate, share, or discuss your favorite books, ShelfShare covers you. 📚✨

---

📖 What is ShelfShare?

ShelfShare is an intuitive desktop application that enables users to:

• Create personalized shelves to organize books in PDF format.
• Collaborate and discuss books with others through forums.
• Annotate and highlight PDFs with advanced editing tools.
• Track reading progress and share it with friends.
• Discover new books via public shelves.

With ShelfShare, reading becomes an individual activity and a community experience. It's perfect for book clubs, student groups, or anyone who loves reading and sharing!

---

🌟 Features

1. Shelves

   • Private and Public Shelves: Keep your shelves accessible only to friends or share them with the world.
   • Permissions: Decide who can edit or view your books.
   • Forums: Each shelf has its dedicated forum for discussions.

2. Book Editing

   • Highlight, underline, and strike through text.
   • Leave sticky notes directly on PDF pages.
   • Quote sections for in-depth discussions.

3. Recommendations & Ratings

   • Rate shelves to help others discover the best collections.
   • Explore top-rated public shelves tailored to your interests.

4. User-Friendly Interface

   • Intuitive navigation with features like sidebars and toolbars.
   • Profile customization and settings for a personalized experience.

---

🚀 Getting Started

Prerequisites

• Java JDK
• IDE like IntelliJ IDEA or Eclipse
• Basic understanding of Java and GUI development

Installation

1. Clone the repository:

   git clone https://github.com/ekerburak/shelfshare.git
   cd ShelfShare
   

2. Build the project: Open the project in your preferred IDE. Utilize maven to read out the contents of the pom.xml file to resolve dependencies.

3. Run the application: Run the App.java to start ShelfShare on your local machine.

WARNING: API keys are removed in one of the final commits. They were solely for demo purposes. Therefore, the app will not start unless you provide appropriate API keys (for MongoDB and Postmark).