Skip to content

README.md

Latest commit

 

History

History
88 lines (66 loc) · 2.75 KB

README.md

File metadata and controls

88 lines (66 loc) · 2.75 KB
Raw

Paperly — Research Papers, Understood 📄✨

Live Demo

Paperly is an AI-powered tool that transforms complex research papers into clear, plain-English explanations and runnable code.

Paperly App

Features

  • Summary & Explanation: Breaks down papers into key concepts, assumptions, and results.
  • Runnable Notebooks: Automatically generates a Python notebook (Colab compatible) to reproduce experiments or explore concepts.
  • Multi-Provider AI: Uses a robust chain of AI providers (Groq Llama 3/3.1, Cerebras, SambaNova, Google Gemini, OpenRouter) for fast, free, and reliable inference.
  • Session Persistence: Saves your analysis locally so you can resume later.
  • Interactive Dashboard: Track implementation tasks and download code.

Tech Stack

  • Frontend: Vite + Vanilla JS (no framework overhead)
  • Backend: Node.js + Express
  • AI Inference: Groq, Cerebras, SambaNova, Google Gemini, OpenRouter (via OpenAI-compatible APIs)
  • Styling: Custom CSS variables for a clean, dark-mode aesthetic

Getting Started

  1. Clone the repo

    git clone https://github.com/yourusername/paperly.git
cd paperly

  2. Install dependencies

    npm install

  3. Set up environment variables Create a .env file in the root directory:

    PORT=3001
GROQ_API_KEY=gsk_...
# Optional backups:
CEREBRAS_API_KEY=csk-...
SAMBANOVA_API_KEY=...
GEMINI_API_KEY=AIza...
OPENROUTER_API_KEY=sk-or-v1-...

# Sponsor premium payments (Razorpay)
RAZORPAY_KEY_ID=rzp_test_...
RAZORPAY_KEY_SECRET=...
USD_TO_INR_RATE=85
SPONSOR_MIN_USD=2
SPONSOR_MAX_USD=500

# Premium access token signing
PREMIUM_TOKEN_SECRET=replace-with-a-long-random-secret
PREMIUM_DAYS=30
FREE_LIMIT_PER_HOUR=3
PREMIUM_LIMIT_PER_HOUR=30

  4. Run locally

    # Terminal 1: Start Backend
npm run server

# Terminal 2: Start Frontend
npm run dev

  5. Open browser Go to http://localhost:5173

Deployment

Frontend (Vercel/Netlify)

The dist folder generated by npm run build can be deployed to any static host.

Backend (Render/Railway)

The server/index.js needs a Node.js environment. You can deploy the entire repo to Render.com as a Web Service:

  • Build Command: npm install && npm run build
  • Start Command: npm run server

Copyright & License

Copyright (c) 2026. All Rights Reserved.

This project is proprietary software. Unauthorized copying, modification, distribution, or use of this software is strictly prohibited. See the LICENSE file for details.