https://github.com/mujhtech/literature-review
https://github.com/mujhtech/literature-review
Last synced: 11 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/mujhtech/literature-review
- Owner: Mujhtech
- Created: 2025-03-15T10:20:12.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-03-15T19:47:59.000Z (over 1 year ago)
- Last Synced: 2025-03-28T00:43:00.758Z (about 1 year ago)
- Language: TypeScript
- Size: 121 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Literature Review Assistant
An AI-powered tool that helps students analyze research papers for their literature review. The application extracts key information from PDF papers and evaluates their relevance to the student's research topic.
## Features
- Upload multiple PDF research papers
- Extract key information:
- Aim/Purpose
- Methodology
- Results
- Scope
- Relevance to research topic
- Modern, responsive UI
- Real-time analysis feedback
## Prerequisites
- Node.js 18+ and npm/pnpm
- OpenAI API key
## Setup
1. Clone the repository:
```bash
git clone
cd literature-review
```
2. Install dependencies:
```bash
pnpm install
```
3. Create a `.env.local` file in the root directory and add your OpenAI API key:
```
OPENAI_API_KEY=your-api-key-here
```
4. Run the development server:
```bash
pnpm dev
```
5. Open [http://localhost:3000](http://localhost:3000) with your browser to see the application.
## Usage
1. Enter your research topic in the input field
2. Upload PDF research papers by dragging and dropping them or clicking the upload area
3. Click "Analyze Papers" to start the analysis
4. View the results for each paper, including:
- Main aim/purpose
- Methodology used
- Key results
- Research scope
- Relevance to your topic
## Technologies Used
- Next.js 14 with App Router
- React 19
- TypeScript
- Tailwind CSS
- Shadcn UI
- LangChain
- OpenAI API
- PDF.js
## License
MIT