brain-bican / taxonomy-development-tools

Tools to build and edit Cell Annotation Schema taxonomies.
Apache License 2.0
3 stars 1 forks source link

Review TDT Quick Start Guide #84

Closed AvolaAmg closed 9 months ago

AvolaAmg commented 9 months ago

Review TDT Quick Start Guide

TDT Quick Start Guide

suggested changes Consider adding the same a similar start to the User Interface Guide

Welcome to the Taxonomy Development Tools User Interface Guide. This document is designed to provide comprehensive details on navigating and utilizing the TDT interface efficiently. Whether you are looking to manage data tables, edit information, or leverage advanced features, this quick start guide will guide you through the set up of TDT

  1. Install requirements (Docker and Git)
  1. Git clone one of the reference projects:

    In this guide nhp_basal_ganglia_taxonomy is used:

    git clone https://github.com/hkir-dev/nhp_basal_ganglia_taxonomy.git
  2. Navigate to the project folder:
    • suggested changes To run the Taxonomy Development Tools, navigate to the Github project folder you have just cloned:
    cd nhp_basal_ganglia_taxonomy
  1. run Taxonomy Development Tools:
    • suggested changes On the terminal, run Taxonomy Developmnet Tools:

MacOS and Linux:

    bash ./run.sh make serve

Windows:

    run.bat make serve
  1. Upon successful execution, you should observe a log stating listening on 0.0.0.0:3000 in the terminal and then be able to browse TDT from http://localhost:3000/table

  2. Details of the TDT user interface can be found at user interface guide.

    • suggested changes Details of the TDT user interface can be found at user interface the link was not working

To create and curate your own taxonomy please follow create your first repository guide.