๐Ÿ–ผ๏ธ
Annotate-Lab
  • ๐Ÿ‘‹Welcome to Annotate Lab
  • Overview
    • โœจKey Features
    • ๐Ÿ—ƒ๏ธProject Structure
    • โš™๏ธCustomization
  • Fundamentals
    • โฌ‡๏ธInstallation
    • ๐Ÿ› ๏ธSet up and Run
      • ๐Ÿ“Configuration
      • ๐Ÿ–ผ๏ธAnnotating Images
      • ๐Ÿ’พOutputs
      • ๐ŸงชRunning Tests
      • ๐Ÿ“”Code Formatting
  • Example
    • ๐ŸšฒAnnotating Bicycle
    • ๐Ÿ–ผ๏ธRipe and Unripe Tomatoes Dataset
    • ๐Ÿช„Auto Bounding Box Selection with Segment Anything Model (SAM)
  • โš ๏ธTroubleshooting
  • ๐ŸชชLicense
Powered by GitBook
On this page
  • Client
  • Server
  • Dependencies
  1. Overview

Project Structure

The tree structure of project is shown below.

annotation-lab/
โ”œโ”€โ”€ client/
โ”‚   โ”œโ”€โ”€ public/
โ”‚   โ”œโ”€โ”€ src/
โ”‚   โ”œโ”€โ”€ package.json
โ”‚   โ””โ”€โ”€ ... (other React app files)
โ”œโ”€โ”€ server/
โ”‚   โ”œโ”€โ”€ db/
โ”‚   โ”œโ”€โ”€ tests/
โ”‚   โ”œโ”€โ”€ app.py
โ”‚   โ”œโ”€โ”€ requirements.txt
โ”‚   โ””โ”€โ”€ ... (other Flask app files)
โ”œโ”€โ”€ README.md

Client

The client is a react application responsible for rendering UI. It contains following folders.

  • public/: Static files and the root HTML file.

  • src/: React components and other frontend code.

  • package.json: Contains client dependencies and scripts.

Server

The server is responsible for persisting information such as images and the working state for future usage. It is also responsible for masking and creating configuration of preserved image. It contains following folders.

  • db/: Database-related files and handlers.

  • tests/: Test files to test the apis.

  • app.py: Main Flask application file.

  • requirements.txt: Contains server dependencies.

Dependencies

Client

  • Other dependencies as listed in package.json

Server

  • Other dependencies as listed in requirements.txt

PreviousKey FeaturesNextCustomization

Last updated 11 months ago

๐Ÿ—ƒ๏ธ
React
Axios
Flask
Pandas
NumPy