gfi-bot icon indicating copy to clipboard operation
gfi-bot copied to clipboard

Outdated Documentation on How to Run and Deploy GFI-Bot

Open hehao98 opened this issue 2 years ago • 2 comments

Currently, all documentation is severely outdated regarding collecting data, training models, understanding the code structure, and deploy the backend & frontend. My proposal is to create a separate DEVELOPMENT.md in the project root folder to explain how to run and deploy GFI-Bot, with the following sections:

  1. A section to explain the current code structure,
  2. A section to describe the database (and point to the database schemas in gfibot.collections),
  3. A section to introduce how to test new functionalities,
  4. A section to describe how to deploy GFI-Bot and make it autonomously collect data, train models, etc., in a new machine. We can add options to make this process more lightweight, such as limiting the number of projects involved so that GFI-Bot can be easily tested on a local machine.

Then, all outdated content in README.md can be replaced by a link to DEVELOPMENT.md.

hehao98 avatar Oct 12 '22 09:10 hehao98

Deployment docs updated in commit 576a5b3

hrz6976 avatar Oct 13 '22 05:10 hrz6976

@hehao98 claim

Sandhya58 avatar Mar 24 '23 05:03 Sandhya58