SwiftDebrief

SwiftDebrief is a revolutionary platform that simplifies research paper analysis. All you have to do is upload your research paper and get a concise summary in seconds. SwiftDebrief analyzes the content and extracts the essential information for you.

Table of Contents

• Introduction
• Features
• Installation
• Usage
• Contributing
• License

Introduction

SwiftDebrief is designed to revolutionize the process of analyzing research papers. By leveraging cutting-edge technologies, including Next.js, react-pdf, the OpenAI API, and framer-motion, SwiftDebrief offers a user-friendly platform for comprehending scholarly content with ease. Whether you're a student, researcher, or industry professional, SwiftDebrief empowers you to efficiently digest complex academic articles.

Features

• Instant Summaries: Upload a research paper and get a concise summary in seconds. SwiftDebrief analyzes the content and extracts the essential information for you.
• Key Points Extraction: Quickly grasp the main ideas of a research paper. SwiftDebrief identifies and highlights the key points, making it easy to understand the core concepts.
• Save Time and Effort: Streamline your research process with SwiftDebrief. No more manual reading and note-taking. Get the information you need in a fraction of the time.
• Audio Summaries: Listen to the summary and key points of research papers with SwiftDebrief's audio feature. Enjoy the convenience of having the insights read out loud to you.

Installation

To run SwiftDebrief locally, follow these steps:

1. Clone the repository:

https://github.com/ASU-CodeDevils/SwiftDebrief.git

2. Navigate to the project directory:

cd SwiftDebrief

3. Install the dependencies:

npm install

4. Run the development server:

npm run dev

5. Open http://localhost:3000 in your browser to view the app.

Usage

Once SwiftDebrief is running, upload a research paper or provide a link to a paper you wish to analyze. The application will generate concise summaries, key points, and audio narration, enabling you to efficiently comprehend the content. Navigate through the original paper using the interactive PDF viewer to explore further details.

Contributing

We welcome contributions from the community to improve SwiftDebrief. To contribute, please follow these guidelines:

• Fork the repository and create a new branch.
• Make your changes and ensure that the code follows our coding standards.
• Submit a pull request detailing the changes you've made and why they're necessary.

For major changes, please open an issue first to discuss the proposed modifications.

License

SwiftDebrief is licensed under the MIT License.