Skip to content

ChemBioHTP/EnzyHTP-GPT

Repository files navigation

EnzyHTP-GPT

A web application that serves as a conversational interface to EnzyHTP's workflows, leveraging Large Language Models (LLMs) to streamline enzyme engineering.

Quick Start

The fastest way to get EnzyHTP-GPT running locally is with Docker Compose.

  1. Clone the repository:

    git clone https://github.com/ChemBioHTP/EnzyHTP-GPT.git
    cd EnzyHTP-GPT
  2. Set up environment variables:

    cp .env.example .env
    # Modify .env as needed
  3. Build and run the application:

    docker compose up -d --build

The application will be available at http://localhost (or the host IP for your Docker machine).

Documentation

For detailed information about the project architecture, development setup, deployment, and more, please refer to our comprehensive documentation in the /docs directory.

  • Architecture: A high-level overview of the system architecture and technology stack.
  • Backend Setup: Instructions for setting up and running the Flask backend.
  • Frontend Setup: Instructions for setting up and running the Vue.js frontend.
  • API Reference: A guide to the backend REST API.
  • AI Agent Workflow: An explanation of the LLM-powered agent workflow.
  • Deployment Guide: Detailed instructions for deploying the application in a production environment.
  • Contributing: Guidelines for contributing to the project.

About

A web application that serves as an interface between a user and EnzyHTP's workflows.

Resources

License

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors