Garden Glossary is a mobile app that helps users identify plants and access cultivation information through photo uploads. The app provides plant identification and key cultivation details sourced from the Royal Horticultural Society (RHS) website or Anthropic's Claude AI.
This monorepo contains both the Flutter mobile application (frontend) and FastAPI service (backend) for the Garden Glossary project:
- Frontend: Flutter mobile app that allows users to capture or upload plant images and displays identification results and cultivation information.
- Backend: FastAPI service hosted on AWS Lambda that handles plant identification and retrieves cultivation details.
garden-glossary/
├── frontend/ # Flutter mobile app
├── backend/ # FastAPI service on AWS Lambda
├── assets/ # Shared assets and documentation resources
├── .gitignore
├── LICENSE # Project license
└── README.md # This file
For detailed setup instructions, refer to the individual READMEs in each directory:
- Flutter SDK (for the frontend)
- Python 3.x (for the backend)
- pip (Python package installer)
- npm (for Serverless deployment of the backend)
- Serverless CLI (for backend deployment)
- AWS Account configured with necessary permissions.
-
Clone the repository:
git clone https://github.com/jplimmer/garden-glossary.git cd garden-glossary -
Set up and run the backend:
cd backend # Follow instructions in backend README
-
Set up and run the Flutter frontend:
cd frontend # Follow instructions in frontend README, including running different flavors of the app
The backend is deployed to AWS Lambda using the Serverless Framework:
cd backend
serverless deployCurrently the Flutter app can be built and installed manually (see the frontend README for detailed instructions), and will hopefully be available through app stores soon.