PaperAI: Your AI-Powered Study buddy and Research Assistant

PaperAI is a cutting-edge web application designed to empower researchers, students, and professionals. It helps users organize, analyze, and summarize study materials efficiently with AI-driven tools, including multi-document chat, advanced note-taking, and automatic summarization.

🚀 Features

🗂 Multi-Document Chat

• Interact with multiple documents simultaneously
• Get instant answers and insights from your research materials
• Seamlessly navigate between different papers while maintaining context

✍️ Advanced Note-Taking

• Automatically generate notes linked to relevant sections of your documents
• Create structured summaries with smart formatting
• Export notes in multiple formats for easy sharing

🧠 AI-Powered Summaries

• Quickly extract concise summaries from your research papers
• Identify key concepts and main arguments
• Generate literature review drafts automatically

📸 Screenshots

Home Page

A seamless introduction to PaperAI's features.

Dashboard with PDF Viewer & Chat

Upload and interact with your research papers effortlessly.

AI-Generated Key Points

Get AI-powered key insights for quick understanding.

🛠️ Installation and Setup

Prerequisites

• Python 3.8+
• Node.js (v16+ recommended)
• Valid Groq Llama API key

Backend Setup

1. Clone the repository and navigate to the backend directory:

   git clone https://github.com/yourusername/paperai.git
   cd paperai-backend

2. Create and activate a virtual environment:

   python -m venv venv
   source venv/bin/activate  # Linux/Mac
   venv\Scripts\activate     # Windows

3. Install Python dependencies:

   pip install -r requirements.txt

4. Add your Groq API Key to the environment:

   export GROQ_API_KEY=your_api_key  # Linux/Mac
   set GROQ_API_KEY=your_api_key     # Windows

5. Run the backend server:

   python app.py

Frontend Setup

1. Navigate to the frontend directory:

   cd ../paperai-frontend

2. Install Node.js packages:

   npm install

3. Start the development server:

   npm start

4. Open your browser and visit:

   http://localhost:3000
   

🚀 Deployment

Building the Frontend

1. Build for production:

   npm run build

2. Serve the production files using a web server (Nginx, Apache) or cloud platforms (AWS, Heroku, Vercel)

🤝 Contributing

We welcome contributions! Here's how to get started:

1. Fork the repository

2. Create a new branch:

   git checkout -b feature/your-feature-name

3. Commit your changes:

   git commit -m "Add your descriptive commit message"

4. Push the branch:

   git push origin feature/your-feature-name

5. Open a pull request

Please ensure your code adheres to our coding guidelines and includes proper documentation.

📜 License

This project is licensed under the MIT License. See the LICENSE file for details.

🙏 Acknowledgments

• OpenAI for providing state-of-the-art language models
• Python and Node.js communities for their incredible tools and libraries
• Groq for API support

Happy studying and researching! 😊