Skip to content

Langgenie is a web application that empowers users to seamlessly explore the wealth of research publications available on arXiv. Beyond simple browsing, Langgenie integrates a robust DocQnA feature, enabling users to pose natural language questions about the content of uploaded PDF documents.

License

Notifications You must be signed in to change notification settings

amulyaprasanth/LangGenie

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

55 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

LangGenie

LangGenie is a cutting-edge AI-powered language generation and translation platform. It combines modern machine learning models with an intuitive user interface to help users generate and translate text effortlessly.


🌟 Features

  • ✏️ Language Generation: Create natural, high-quality text with the help of advanced AI models.
  • 🌐 Translation: Translate text between multiple languages instantly.
  • ⚡️ Seamless Integration: Frontend and backend communicate smoothly for a real-time experience.
  • 🚀 Modern Web Technologies: Fast, responsive, and reliable user interface.

🏗️ Tech Stack

  • Frontend:

    • React
    • Tailwind CSS
    • Vite
    • Axios
  • Backend:

    • Python
    • FastAPI
    • LangChain
    • Hugging Face Transformers
    • GROQ API for enhanced performance
    • Wikipedia & ArXiv retrieval tools

📂 Project Structure

LangGenie/
├── frontend/         # React-based UI
├── backend/          # FastAPI-powered backend
├── LICENSE
└── README.md         # Project documentation (this file)

⚠️ Note: Backend Service Unavailable

The backend service is currently not working because of free tier limitations on Render.com. You can still explore the frontend locally or deploy your own backend instance using the provided code.


⚙️ Installation

🖥️ Prerequisites

  • Node.js and npm (for the frontend)
  • Python 3.9+ and pip (for the backend)
  • Poetry (for backend dependency management)

🚀 Frontend Setup

cd frontend
npm install
# or
yarn install

# Start development server
npm run dev
# or
yarn dev

The frontend will be running at http://localhost:5173.


⚙️ Backend Setup

  1. Install Poetry (if not already installed):

    pip install poetry
  2. Install dependencies:

    cd backend
    poetry install
  3. Configure environment variables (add your GROQ API key to your .env file or export it):

    export GROQ_API_KEY=your_api_key_here
  4. Run the backend app:

    poetry run python app.py

The backend will be running at http://localhost:8000.


🌍 Environment Variables

Frontend

Create a .env file in the frontend directory:

VITE_API_URL=http://localhost:8000

Backend

Ensure your .env file (or exported variables) includes:

export GROQ_API_KEY=your_api_key_here

🧪 Testing

Frontend

npm run lint

(Consider adding unit tests for better code coverage.)

Backend

You can use tools like pytest to add automated tests for the backend API.


⚡ Build for Production

Frontend

npm run build

The production-ready frontend build will be generated in the frontend/dist directory.


🙌 Contributing

Contributions are welcome! Please:

  1. Fork the repository.
  2. Create a new branch for your feature or bug fix.
  3. Submit a pull request with a detailed explanation.

📄 License

This project is licensed under the MIT License.


📞 Contact

For questions, feel free to open an issue on GitHub.


Enjoy using LangGenie! Let us know how we can improve.

About

Langgenie is a web application that empowers users to seamlessly explore the wealth of research publications available on arXiv. Beyond simple browsing, Langgenie integrates a robust DocQnA feature, enabling users to pose natural language questions about the content of uploaded PDF documents.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published