AI Summarizer

Overview

AI Summarizer full-stack application for document and text summarization. Users can upload various file types (such as PDF, DOCX, TXT, PPTX) or paste text, and receive concise or comprehensive summaries.

• Backend: Java (Spring Boot), REST API
• Frontend: TypeScript (React, Vite, TailwindCSS)
• Features: Authentication, user dashboard, history tracking, API usage logs

---

Table of Contents

• Features
• Demo
• Tech Stack
• Project Structure
• Getting Started
• Contributing
• License

---

Features

• ✨ Upload text or various document types for summarization
• 🤖 Choose between brief or detailed summaries
• 📜 View and manage your summarization history
• 👤 Secure authentication and profile management
• 📊 Admin dashboard with API usage analytics
• 🌐 Fast, modern UI

---

Demo

Tech Stack

Layer	Technology
Backend	Java, Spring Boot, Gradle
Frontend	React, TypeScript, Vite, TailwindCSS
Database	(You can specify: PostgreSQL/MySQL/Other)
Auth	Spring Security (JWT or Session-based)

---

Project Structure

ai-summarizer/
├── ai-summarizer-backend/         # Java Spring Boot backend
│   └── src/main/...
├── ai-summarizer-frontend-ts/     # TypeScript React frontend
│   └── src/...
└── README.md

---

Getting Started

Prerequisites

• Java 21
• Node.js (v18+ recommended)
• PostgreSQL v16
• Yarn or npm

Clone the repository

git clone https://github.com/atadurdyyewserdar/ai-summarizer.git
cd ai-summarizer

Backend Setup

cd ai-summarizer-backend
./gradlew build
./gradlew bootRun

Backend runs on: http://localhost:8080

You may need to configure application.yml or application.properties for database and AI service endpoints.

Add envireonmet variables for:

• OPENAI_API_KEY
• DB_USERNAME
• DB_PASSWORD

Frontend Setup

cd ai-summarizer-frontend-ts
npm install         # or: yarn install
npm run dev         # or: yarn dev

Frontend runs on: http://localhost:5173

---

Contributing

1. Fork the repository
2. Create your feature branch:

   git checkout -b my-new-feature

3. Commit your changes:

   git commit -am "Add some feature"

4. Push to the branch:

   git push origin my-new-feature

5. Open a pull request

---

License

This project is licensed under the MIT License.

---

Acknowledgements

• Built with Spring Boot and React
• Frontend bootstrapped with Vite
• UI powered by Tailwind CSS

---

Questions or suggestions?
Open an issue or contact @atadurdyyewserdar on GitHub.