v1.0.0

Introduction

Welcome to the StudyShare documentation. This comprehensive guide will help you understand every aspect of the platform.

What is StudyShare?
StudyShare is a smart, modern platform designed for students. It seamlessly blends powerful document management with AI assistance, making discovering and understanding study materials simple, secure, and intuitive.

Quick Start

Ready to dive right in? Use our interactive dashboard features to start boosting your productivity. StudyShare is designed out of the box to instantly organize and process your PDFs.

  1. Create an account: Sign up quickly securely using Google Authentication.
  2. Setup your profile: Selecting your University and Branch allows us to recommend tailored content just for you.
  3. Upload a Document: Provide any standard PDF document (slides, textbooks, exams) and let the engine do the heavy lifting of OCR & structuring.

Core Workflows

Explore the primary capabilities of StudyShare.

Upload & Organize Materials

Drag-and-drop workflow with robust metadata extraction, sorting everything correctly.

AI Assistant

A fully integrated conversational chatbot utilizing advanced AI models to answer your study questions.

Automated OCR Extraction

Powered by Anthropic Claude for converting raw images/pdfs into structured JSON data.

Developer APIs for Integrations

Leverage the backend REST API directly in your own applications.

Prerequisites

Before you begin configuring the developer tools, ensure that your system has the following requirements. If you are just using the web app, you won't need these:

json
{
  "node": ">= 20.x",
  "npm": ">= 10.x"
}

Having Trouble?

If these documentation pages do not answer your question, or if you encounter a bug, please create a ticket detailing the issue or look at our platform status.