{"id":31949502,"url":"https://github.com/arifozcan35/shadowise-api","last_synced_at":"2025-10-14T12:32:18.883Z","repository":{"id":318451786,"uuid":"1026854295","full_name":"arifozcan35/shadowise-api","owner":"arifozcan35","description":"Shadowise API is a Spring Boot application that automatically generates quiz questions, flashcards, and summaries from user-uploaded PDF documents using artificial intelligence. It is designed to optimize the learning processes of students and educators.","archived":false,"fork":false,"pushed_at":"2025-10-07T08:06:14.000Z","size":350,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-10-07T10:10:07.723Z","etag":null,"topics":["api","artificial-intelligence","docker-compose","java","jwt","mongodb","spring-boot","spring-security"],"latest_commit_sha":null,"homepage":"","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/arifozcan35.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-07-26T18:52:46.000Z","updated_at":"2025-10-07T08:15:29.000Z","dependencies_parsed_at":"2025-10-07T10:21:10.104Z","dependency_job_id":null,"html_url":"https://github.com/arifozcan35/shadowise-api","commit_stats":null,"previous_names":["arifozcan35/shadowise-api"],"tags_count":null,"template":false,"template_full_name":null,"purl":"pkg:github/arifozcan35/shadowise-api","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/arifozcan35%2Fshadowise-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/arifozcan35%2Fshadowise-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/arifozcan35%2Fshadowise-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/arifozcan35%2Fshadowise-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/arifozcan35","download_url":"https://codeload.github.com/arifozcan35/shadowise-api/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/arifozcan35%2Fshadowise-api/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":279018663,"owners_count":26086576,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-10-14T02:00:06.444Z","response_time":60,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api","artificial-intelligence","docker-compose","java","jwt","mongodb","spring-boot","spring-security"],"created_at":"2025-10-14T12:32:00.351Z","updated_at":"2025-10-14T12:32:18.879Z","avatar_url":"https://github.com/arifozcan35.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"# 🎓 Shadowise API\n\nAI-powered intelligent learning platform RESTful API service.\n\n## 📋 About The Project\n\nShadowise API is a Spring Boot application that automatically generates quiz questions, flashcards, and summaries from user-uploaded PDF documents using artificial intelligence. It is designed to optimize the learning processes of students and educators. I developed this project within the scope of BTK Hackathon 2025.\n\n## ✨ Features\n\n### 🔐 Authentication \u0026 Authorization\n- JWT-based secure authentication\n- User registration and login system\n- Refresh token support\n- Role-based access control\n\n### 📁 Project Management\n- Create and manage projects\n- File upload and organization\n- Project-based content organization\n- Dashboard statistics\n\n### 🤖 AI-Powered Content Generation\n- **PDF Processing**: Upload and process PDF files\n- **Automatic Summarization**: Generate AI-powered summaries from documents\n- **Quiz Generation**: Create multiple-choice questions\n- **Flashcard Creation**: Generate question-answer cards\n- Customizable parameters (number of questions, word limit, etc.)\n\n### 📊 Content Management\n- Quiz management and score tracking\n- Flashcard collections\n- Note-taking system\n- File download and viewing\n\n## 🛠️ Technologies\n\n### Backend\n- **Java 21** - Programming language\n- **Spring Boot 3.2.4** - Application framework\n- **Spring Security** - Security and authentication\n- **Spring Data MongoDB** - Database access\n- **Spring Cloud OpenFeign** - Microservice communication\n\n### Database\n- **MongoDB** - NoSQL document database\n\n### Libraries \u0026 Tools\n- **JWT (JSON Web Token)** - Token-based authentication\n- **Lombok** - Code optimization\n- **MapStruct** - DTO mappings\n- **SpringDoc OpenAPI** - API documentation (Swagger UI)\n- **Docker** - Containerization\n\n## 📦 Installation\n\n### Requirements\n- Java 21 or higher\n- Maven 3.6+\n- MongoDB 4.0+\n- Docker (optional)\n\n## 🚀 Usage\n\n### API Documentation\nAfter running the application, you can explore the API via Swagger UI:\n\n```\nhttp://localhost:8080/swagger-ui.html\n```\n\n### Main Endpoints\n\n#### Authentication\n- `POST /api/auth/sign-up` - Register new user\n- `POST /api/auth/sign-in` - User login\n- `POST /api/auth/refresh-token` - Refresh token\n- `POST /api/auth/logout` - Logout\n\n#### Project Operations\n- `GET /api/projects/my-projects` - List user's projects\n- `POST /api/projects/create-with-files` - Create project with files\n- `GET /api/projects/{id}` - Get project details\n- `PUT /api/projects/{id}` - Update project\n- `DELETE /api/projects/{id}` - Delete project\n\n#### AI Operations\n- `POST /api/ai/upload-pdf` - Upload PDF\n- `POST /api/ai/generate-summary` - Generate summary\n- `POST /api/ai/generate-questions` - Generate quiz questions\n- `POST /api/ai/generate-flashcards` - Generate flashcards\n\n#### Quiz Operations\n- `GET /api/quiz` - List quizzes\n- `POST /api/quiz` - Create quiz\n- `GET /api/quiz/{id}` - Get quiz details\n- `PUT /api/quiz/{id}/score` - Update score\n\n#### Flashcard Operations\n- `GET /api/flashcard` - List flashcards\n- `POST /api/flashcard` - Create flashcard\n- `GET /api/flashcard/{id}` - Get flashcard details\n\n## 📂 Project Structure\n\n```\nsrc/main/java/tr/shadowise_api/\n├── client/              # External API clients\n├── config/              # Configuration classes\n├── controller/          # REST Controllers\n├── core/                # Core response structures\n├── dto/                 # Data Transfer Objects\n├── entity/              # MongoDB Entities\n├── exception/           # Custom exceptions\n├── payload/             # Request/Response payloads\n├── repository/          # MongoDB Repositories\n├── service/             # Business logic services\n└── utils/               # Utility classes\n```\n\n## 🔒 Security\n\n- JWT-based authentication\n- Password encryption (BCrypt)\n- CORS configuration\n- Role-based authorization\n- Data security with soft delete\n\n## 🌍 Environment Profiles\n\nThe application includes profiles for different environments:\n- **dev** - Development environment\n- **prod** - Production environment\n\nProfile selection:\n```bash\njava -jar app.jar --spring.profiles.active=prod\n```\n\n## 📞 Contact\n\n- **Developer**: Arif Özcan\n- **Email**: zcanarif@gmail.com\n- **GitHub**: [@arifozcan35](https://github.com/arifozcan35)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Farifozcan35%2Fshadowise-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Farifozcan35%2Fshadowise-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Farifozcan35%2Fshadowise-api/lists"}