Research Mate

A modern, intuitive interface for streamlining academic research workflows

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Key Features
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
   • Environment Variables
3. Usage
4. Project Structure
5. Roadmap
6. Contributing
7. License
8. Contact
9. Acknowledgments

What is ResearchMate ?🤔

Hi, I’m Shrinidhi. Like many students, I found myself drowning in a sea of PDFs while working on my academic research. Between managing dozens of papers, tracking my progress, and trying to analyze complex data quickly, I felt overwhelmed. I realized there had to be a better way to work.

That’s why I built Research Mate.

I wanted to create a platform that doesn't just store documents, but actually helps you understand them. By bridging the gap between AI-driven analysis and intelligent document management, Research Mate turns a chaotic folder of PDFs into a streamlined, intuitive workspace. It’s built by a researcher, for researchers. Management.

• AI-Powered Analysis:

  • Auto Annotation: Mention the text you want to annotate and the AI will automatically annotate it for you.
  • Auto Tagging: you write the paragraph and ai will tag papers for you based on the paragraph.
  • Automated Summarization: Instantly generate concise summaries to grasp the core concepts of complex papers.
  • Interactive Q&A Basically RAG: Chat directly with your documents to extract specific data points or clarify difficult sections.
  • Intelligent Extraction: Automatically identify and organize key findings, methodologies, and references.

• Comprehensive Document Management:

  • Centralized Repository: Store and manage all your research PDFs, notes, and datasets in one secure location, currently we are limited to the Text files.
  • Advanced Annotation: Highlight text and add persistent comments directly within the integrated PDF viewer.
  • Smart Organization: Utilize multi-level categorization and automated metadata extraction for effortless retrieval.

Boosting Productivity

• Smart Document Management - Organize, annotate, and search through research papers effortlessly
• Collaborative Workspace - Share findings and collaborate with team members in real-time
• Advanced Search - Powerful filtering and semantic search capabilities
• Citation Generator - Automatically format citations in multiple styles (APA, MLA, Chicago, etc.)
• Reading Mode - Distraction-free interface optimized for reading and note-taking
• Responsive Design - Seamless experience across desktop, tablet, and mobile devices

(back to top)

Built With

• 

(back to top)

Getting Started

Follow these steps to set up Research Mate Frontend locally.

Prerequisites

Ensure you have the following installed on your system:

• Node.js (v18.0.0 or higher)

  node --version

• npm

  npm install npm@latest -g

Installation

1. Clone the repository

   git clone https://github.com/yourusername/research-mate-frontend.git

2. Navigate to the project directory

   cd research-mate-frontend

3. Install NPM packages

   npm install

4. Create a .env file in the root directory (see Environment Variables)

5. Start the development server

   npm run dev

The application will be available at http://localhost:5173

Environment Variables

Create a .env file in the root directory with the following variables:

VITE_API_BASE_URL=http://localhost:8000/api
VITE_APP_NAME=Research Mate
VITE_ENABLE_ANALYTICS=false

(back to top)

Usage

Development Mode

Run the development server with hot module replacement:

npm run dev

Build for Production

Create an optimized production build:

npm run build

Preview Production Build

Preview the production build locally:

npm run preview

Run Tests

Execute the test suite:

npm run test

Lint and Format

Check code quality:

npm run lint
npm run format

For comprehensive documentation, please refer to the Documentation

(back to top)

Project Structure

research-mate-frontend/
├── public/
│   └── images/
├── src/
│   ├── assets/
│   ├── components/
│   │   ├── common/
│   │   ├── layout/
│   │   └── features/
│   ├── hooks/
│   ├── pages/
│   ├── services/
│   ├── store/
│   ├── types/
│   ├── utils/
│   ├── App.tsx
│   └── main.tsx
├── .env.example
├── package.json
├── tsconfig.json
├── vite.config.ts
└── README.md

(back to top)

Contributing

Contributions make the open source community an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

shrinidhiachar857@gmail.com

(back to top)

Acknowledgments

• React Documentation
• Vite Guide
• TailwindCSS
• Font Awesome
• React Icons
• Scadcn ui
• Lottie Files

(back to top)

---

Thank you for checking out this project.
Have a great day and happy coding! 😊