LangChainAssist

LangChainAssist is a project that integrates LangChain with a React frontend and a Python backend using FastAPI. This application leverages PatternFly for UI components and styling, providing an interface to interact with LangChain functionalities to connect with Red Hat Composer AI Assistants

Table of Contents

• Getting Started
• Prerequisites
• Installation
• Usage
• Features
• Contributing
• License

Getting Started

To get a copy of this project up and running on your local machine, follow the installation instructions below.

Prerequisites

Before you begin, ensure you have the following installed on your system:

• Node.js (for the React frontend)
• Python 3.x (for the FastAPI backend)
• pip (Python package installer)

Installation

1. Clone the repository

   git clone https://github.com/solaius/LangChainAssist.git
   cd LangChainAssist

2. Install frontend dependencies Navigate to the frontend directory and install the necessary packages:

   cd frontend
   npm install

3. Install backend dependencies Navigate to the backend directory and install the required Python packages:

   cd ../backend
   pip install -r requirements.txt

4. Set up environment variables Create a .env file in the backend directory and add your environment variables, such as API keys and configurations.

Usage

1. Run the backend server In the backend directory, start the FastAPI server:

   uvicorn main:app --reload

2. Run the frontend In a new terminal, navigate to the frontend directory and start the React development server:

   cd frontend
   npm start

3. Access the application Open your web browser and go to http://localhost:3000 to use LangChainAssist.

Features

• Integration with LangChain for advanced language processing capabilities.
• React frontend with PatternFly for a consistent and modern UI.
• FastAPI backend for efficient and scalable API handling.
• Support for light/dark themed elements in the frontend.
• Modular and extensible codebase for easy addition of new features.

Contributing

Contributions are welcome! If you would like to contribute to this project, please follow these steps:

1. Fork the repository
2. Create a new branch (git checkout -b feature-branch)
3. Make your changes
4. Commit your changes (git commit -m 'Add new feature')
5. Push to the branch (git push origin feature-branch)
6. Create a Pull Request

License

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

This README.md file provides an overview of the project, setup instructions, and other useful information for users and contributors. Make sure to update any section that might require specific details related to your project.