TellTail

Upload an image of your cat or dog and we will tell you its breed and more

Link: https://tail-tell.vercel.app/

Trello

https://trello.com/b/bruFHEAQ/cs-362-group-15-project-board

Tech Stack

Frontend

Backend

Model Backbones

Tools and Libraries

Diagram of TellTail

https://drive.google.com/file/d/1aQUYL65NAHzgO3qLxj3eLWHvnx3il3UL/view?usp=sharing

Group Google Doc

https://docs.google.com/document/d/1I5ed4LH9b9D_w5H8N8RbtgJrdjqqeIZ3JoOhrqkK7HI/edit?usp=sharing

UI Wireframe

https://www.figma.com/proto/9pO4CqLVWCrOygnr24prP4/Untitled?node-id=0-1&t=yrwT2gFLRzfkS8Ax-1

Installation

1. Clone this repository:

   git clone https://github.com/hackermanosu/tailtell.git

2. Install dependencies:

   cd TellTail/frontend
   npm install

Running The App

Option 1 - Run natively:

1. Run the app (in the "tailtell/frontend/" folder):

   npm run dev

2. Follow the instructions provided by Vite

   • Usually this involves navigating to localhost:5173 in your web browser of choice.

Option 2 - Use the web:

Navigate to https://tail-tell.vercel.app/ to use the app on the web.

Testing

1. Make sure that the app is already installed locally (see "Installation")
2. Run tests using Vitest test system:

   cd TellTail/frontend
   npm run dev

Project Structure

Details

$PROJECT_ROOT
├── backend
│   ├── pth_files
│   ├── README.md
│   ├── api.env
│   ├── catApi.ts
│   ├── convert to tensorflow.py
│   ├── dogApi.ts
│   ├── predict_cat_breed.py
│   ├── predict_dog_age.py
│   ├── predict_dog_breed.py
│   ├── predict_dog_lifestage.py
│   ├── preliminary_server.py
│   └── training_cat_breed.py
│
├── frontend
│   ├── public
│   │   ├── cat_breed_model.onnx
│   │   ├── dog_age_model.onnx
│   │   ├── dog_breed_model.onnx
│   │   ├── dog_lifestage_model.onnx
│   │   ├── ort-wasm-simd-threaded.jsep.wasm
│   │   └── ort-wasm-simd-threaded.wasm
│   │
│   ├── src
│   │   ├── components
│   │   │   ├── About Us
│   │   │   ├── Drop Field
│   │   │   │   ├── CatDropField.tsx
│   │   │   │   └── DogDropField.tsx
│   │   │   ├── Drop Page
│   │   │   ├── Header
│   │   │   ├── Home
│   │   │   ├── Instructions
│   │   │   └── Profiles
│   │   │       ├── CatProfiles.tsx
│   │   │       └── DogProfile.tsx
│   │   │
│   │   ├── App.css
│   │   ├── App.tsx
│   │   ├── index.css
│   │   ├── main.tsx
│   │   └── vite-env.d.ts
│   │
│   ├── README.md
│   ├── eslint.config.js
│   ├── index.html
│   ├── package-lock.json
│   ├── package.json
│   ├── postcss.config.js
│   ├──tailwind.config.js