Skip to content

Latest commit

 

History

History
70 lines (52 loc) · 2.85 KB

README.md

File metadata and controls

70 lines (52 loc) · 2.85 KB

Research-Assistant

Overview

The Research-Assistant is a tool designed to streamline and enhance the research process. It provides functionalities such as Summarization of complex articles, suggestion for similar readings, notes taking feature, and it works with PDFs also!. This project aims to reduce the time spent on initial research, improve organization of research materials, etc.

Features

  • Automated Literature Review: Automatically gathers and summarizes relevant research papers based on keywords.
  • Integrated Note-Taking: Allows users to take notes directly within the application, linking them to specific sources.
  • Citation Management: Generates citations in various formats (e.g., APA, MLA, Chicago) for easy integration into research papers.

Technologies Used

  • Backend: Java (with Maven for dependency management) with Spring Boot
  • Frontend: JavaScript, HTML, CSS

Setup and Installation

  1. Prerequisites:

    • Java Development Kit (JDK) 8 or higher
    • Maven

  2. Installation Steps:

    # Clone the repository
git clone https://github.com/anuragmuley09/Research-Assistant-.git

# Navigate to the project directory
cd Research-Assistant-

# Build the project using Maven
mvn clean install

# [Add any specific instructions for running the application,
# e.g., running a specific Java class or deploying to a server]

Usage

  1. Running the Application:
    • After installation, run the application using [specific commands or instructions].
  2. Key Workflows:
    • Starting a New Research Project: Describe how users can initiate a new research project within the application.
    • Performing a Literature Review: Explain how to use the automated literature review feature, including setting keywords and filters.
    • Taking and Organizing Notes: Guide users on how to create, link, and organize notes within the application.
    • Generating Citations: Show users how to generate citations in different formats.

Project Structure

Research-Assistant/
├── .mvn/                  # Maven Wrapper configuration
├── Research-Extension/    # Chrome Extension 
├── src/                   # Source code
│   ├── main/
│   │   ├── java/          # Java source files
│   │   ├── resources/     # Resource files (e.g., configuration, data)
│   ├── test/              # Test code
├── .gitattributes         # Git attributes
├── .gitignore             # Specifies intentionally untracked files that Git should ignore
├── mvnw                   # Maven Wrapper script for Unix-like systems
├── mvnw.cmd               # Maven Wrapper script for Windows
├── pom.xml                # Maven project configuration file
└── README.md              # This file