Skip to content

v3.0.0

Latest
Latest

Choose a tag to compare

View all tags
@JustinTruong456 JustinTruong456 released this 28 Apr 05:36
v3.0.0
f7c3eeb
This commit was created on GitHub.com and signed with GitHub’s verified signature.
GPG key ID: B5690EEEBB952194
Verified
Learn about vigilant mode.

Release notes - Bioinformatics Software Tutorial Supporting Chatbot - 3.0.0

Bug

BSCB-169 Backend Docker Service fails to build on MacBook Pro M2 Max

BSCB-170 "Reuse Document Context" mode removes the document restriction and turns it into Chatgpt chatbot

Task

BSCB-136 Update Algorithm Description in System Architecture

BSCB-163 Review Requirements Document

BSCB-164 Review System Architecture

BSCB-165 Review API Specification

BSCB-166 Review Test Procedures

BSCB-168 Add Hosting Tab in Docs

Story

BSCB-150 Setup instructions are incomplete

BSCB-152 Improve the download chat icon; it's ambiguous

BSCB-153 Fix “No Document Found” error on expected Bioinformatics topics

BSCB-154 Multiple submissions are allowed while awaiting a response

BSCB-155 Enter button sends query and shift+enter is new line

BSCB-156 New Chat Button

BSCB-158 Add Stop llm response generation button

BSCB-160 Swap enter & download + add padding

BSCB-161 Add toggle between allowing responses w/ only filtered docs and allowing all responses

BSCB-167 Backend UI small touchup

Full Changelog here

How to run this project in your own environment?

Note: You will need to add your own Document for the Chatbot to work

  1. Install and Open Docker Desktop and Vscode
  2. Download and unzip the source code in the most recent project release.
  3. In Vscode open the project file after you unzip, in the backend folder create .env file and database.env
  4. In the .env file put this
#database variables
POSTGRES_USER=admin
POSTGRES_PASSWORD=admin
POSTGRES_DB=database
POSTGRES_HOST_AUTH_METHOD=trust
  1. In the database.env put this:
#database variables
POSTGRES_USER=admin
POSTGRES_PASSWORD=admin
POSTGRES_DB=database
POSTGRES_HOST_AUTH_METHOD=trust
  1. If on Windows, update docker-entrypoint.sh in backend, and docker-compose.yml, to LF format from CRLF format in Vscode by hiting ctrl+shift+p and clicking on "Change End of Line Sequence" and LF. There won't be any noticeable changes but it will change the end of line sequence. Then save the files.
  2. In vscode open the terminal and cd to the project from current release number because after you extract the file, the project is going be in a folder with the same name.
  • For example, release v1.0.0 cd project-003-bioinformatics-chatbot-1.0.0
  • or release v2.0.0 cd project-003-bioinformatics-chatbot-2.0.0
  1. Run this command in the terminal, it may take a while to build due to LLM.
    docker compose -f docker-compose.yml up --build
  2. Frontend host is http://localhost:5173/
    Backend host is http://localhost:444/
    Default Username is admin
    Default Password is admin

How to Host and port forward this project to use in your own lab?

(Please check Hardware requirement below before proceeding)

  1. Click this link Hosting to access the branch purposely made for Hosting service
  2. Then read this documentation for more information.

Required Resources

Hardware Requirements for local development

  • A computer with a modern operating system (Windows, macOS, or Linux)
  • At least 8 GB of RAM
  • At least 2 GB of free disk space

Hardware Requirements for Hosting service

  • A computer with a modern operating system (Windows, macOS, or Linux)
  • At least 8GB of RAM
  • At least 10 GB of VRAM (Prefer 12GB NVIDIA GPU with CUDA support)
  • At least 2 GB of free disk space

Software Requirements

  • An up-to-date web browser:
    • Google Chrome: Version 131 or later
    • Mozilla Firefox: Version 133 or later
    • Microsoft Edge: Version 131 or later
    • Apple Safari: Version 18.0 or later
  • Docker Desktop (handles all required dependencies for development)
  • Internet access
Assets 2
Loading