Your Intelligent Research Co-Pilot
Research-Buddy is a next-generation research analysis tool designed to deconstruct complex scientific papers into actionable insights. Powered by Google Gemini 2.0 Flash, it transforms static PDFs into interactive knowledge graphs, executable code replication, and deep comparative analysis.
- Multi-Paper Synthesis: Upload multiple PDFs to automatically detect commonalities, contradictions, and architectural differences.
- Interactive Method Pipelines: Visualizing complex methodologies as dynamic, force-directed graphs using D3.js.
- Auto-Coder: Generates PyTorch/Python implementation code directly from the paper's methodology section.
- Downloadable Packs: Export replication scripts (
.py) and full experiment data (.json) with one click.
- Creative Variants: The AI suggests novel experimental modifications (e.g., "Speed Demon" or "Efficiency Mod") to improve the paper's results.
- Impact Prediction: Estimates the computational cost and accuracy impact of each suggested variant.
- Research Assistant: A built-in chat console that "reads" the paper with you, answering technical queries with precise citation context.
Built with a focus on performance, modern aesthetics, and scalability.
- Frontend: React 19, Vite
- Styling: Tailwind CSS (Deep Glassmorphism Design System)
- AI Engine: Google Gemini (via Google GenAI SDK)
- Visualization: D3.js (Force-directed graphs)
- Infrastructure: Docker, Google Cloud Run
- Node.js 20+
- A Google Gemini API Key
-
Clone the repository
git clone https://github.com/yourusername/research-buddy.git cd research-buddy -
Install dependencies
npm install
-
Configure Environment Create a
.env.localfile in the root directory:VITE_GEMINI_API_KEY=your_api_key_here
-
Run Development Server
npm run dev
Research-Buddy is containerized for easy deployment to Google Cloud Run or any Docker-compatible host.
# Build the image
docker build -t research-buddy .
# Run locally (injecting API key)
docker run -p 8080:8080 -e VITE_GEMINI_API_KEY=your_key research-buddyCloud Run Note: This project uses a runtime environment injection script (
env.sh) so you can update environment variables in the Cloud Console without rebuilding the image.
Automated policies are enforced via GitHub Actions:
- Continuous Integration: Runs type checking (
tsc) and build validation (npm run build) on every push and pull request. - Docker Verification: Ensures the
Dockerfilebuilds correctly in a clean environment.
The UI follows a "Deep Void" aesthetic—utilizing deep blacks, emerald accents, and glassmorphism to create a futuristic, distraction-free reading environment.