Skip to content

README.md

Latest commit

 

History

History
85 lines (83 loc) · 2.55 KB

README.md

File metadata and controls

85 lines (83 loc) · 2.55 KB

Auto Research AI

Auto Research AI is a full-stack application that allows users to input any research query and receive high-quality, summarized answers using web search data and generative AI. The platform streamlines the research process by combining SERP results with LLM-based summarization.

Tech Stack

Backend

Frontend

  • Framework: React.js
  • Styling: Tailwind CSS
  • Authentication: Clerk for secure user login and session management

Features

  • User authentication using Clerk
  • Search anything and fetch relevant data via SerpAPI
  • Summarize search results using Google s Gemini model
  • Store all queries and summaries in a PostgreSQL database Auto Research AI - README
  • View past queries with summaries in your dashboard
  • Fast and modern UI built with React and Tailwind CSS

Setup Instructions

1. Clone the repository

git clone https://github.com/Dipit12/Auto-Research-AI.git
cd auto-research-ai

2. Backend Setup

cd server
npm install
npx prisma generate
npx prisma migrate dev --name init
node dist/index

Create a .env file in the server/ directory with: Auto Research AI - README

DATABASE_URL=your_neon_database_url
SERP_API_KEY=your_serp_api_key
GEMINI_API_KEY=your_gemini_api_key

3. Frontend Setup

cd client
npm install
npm run dev

Authentication

This project uses Clerk.dev for authentication. Set the following variables in the frontend .env.local file:

NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY=your_key
CLERK_SECRET_KEY=your_secret_key

LLM Integration

Search queries are processed through SerpAPI, and the results are summarized using the Gemini Pro API for optimal clarity and conciseness. Auto Research AI - README

Deployment

  • Frontend: Deployable to Vercel
  • Backend: Deployable to Render, Railway, or Cloudflare Workers (if converted to Hono)

Acknowledgements

License

This project is licensed under the MIT License. Feel free to fork and contribute!