Skip to content

Commit a5e0a6c

Browse files
committed
Add professional enterprise documentation in README.md
1 parent 349a84d commit a5e0a6c

1 file changed

Lines changed: 151 additions & 14 deletions

File tree

README.md

Lines changed: 151 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,158 @@
1-
<div align="center">
2-
<img width="1200" height="475" alt="GHBanner" src="https://ai.google.dev/static/site-assets/images/share-ais-513315318.png" />
3-
</div>
1+
# 🌾 NuKropAI — Autonomous Agriculture AI Operating System
42

5-
# Run and deploy your AI Studio app
3+
[![Build Status](https://img.shields.io/badge/Build-Passing-brightgreen.svg)](https://github.com/JACK-AI7/NuKropAI)
4+
[![Version](https://img.shields.io/badge/Version-v1.0.0-blue.svg)](https://github.com/JACK-AI7/NuKropAI)
5+
[![Kotlin](https://img.shields.io/badge/Kotlin-2.0.21-purple.svg)](https://kotlinlang.org/)
6+
[![Android SDK](https://img.shields.io/badge/TargetSDK-34%2F36-green.svg)](https://developer.android.com/studio)
7+
[![Backend](https://img.shields.io/badge/Node.js-v20%2B-darkgreen.svg)](https://nodejs.org/)
8+
[![Database](https://img.shields.io/badge/Supabase-Auth%20%26%20DB-emerald.svg)](https://supabase.com/)
9+
[![AI Engine](https://img.shields.io/badge/Groq%20LLM-Llama%203.3%20%2F%203.2-orange.svg)](https://groq.com/)
610

7-
This contains everything you need to run your app locally.
11+
**NuKropAI** is an enterprise-grade, full-stack smart agriculture operating system designed to empower farmers, agronomists, and agricultural enterprises with AI-driven vision diagnostics, real-time market data, telemetry, and automated crop management tools.
812

9-
View your app in AI Studio: https://ai.studio/apps/e6f8fc34-29e7-4bed-9b6d-eaa28f15ebca
13+
---
1014

11-
## Run Locally
15+
## 🚀 Key Modules & Features
1216

13-
**Prerequisites:** [Android Studio](https://developer.android.com/studio)
17+
### 🌿 1. AI Crop Disease Scanner & Soil Health Analysis
18+
* **Groq Vision LLM Integration**: Multi-model fallback (`llama-3.2-11b-vision-preview`, `llama-3.2-90b-vision-preview`) for instant visual disease diagnosis on crop leaves and stems.
19+
* **Treatment & Product Matching**: Returns exact disease names, severity levels, confidence scores, and real brand-name Indian agricultural products (pesticides, fungicides) with precise dosages and purchase links.
20+
* **Soil Composition & NPK Estimator**: Evaluates soil texture, pH range, organic matter content, and NPK deficiency recommendations.
1421

22+
### 🔐 2. Enterprise Authentication & User Management
23+
* **Supabase Integration**: Auth engine backed by Supabase Kotlin SDK (`auth-kt`). Supports email/password authentication, persistent user sessions, metadata synchronization, and guest modes.
24+
* **Secure Profile & Data Security**: Full user profile customization with fallback metadata extraction.
1525

16-
1. Open Android Studio
17-
2. Select **Open** and choose the directory containing this project
18-
3. Allow Android Studio to fix any incompatibilities as it imports the project.
19-
4. Create a file named `.env` in the project directory and set `GEMINI_API_KEY` in that file to your Gemini API key (see `.env.example` for an example)
20-
5. Remove this line from the app's `build.gradle.kts` file: `signingConfig = signingConfigs.getByName("debugConfig")`
21-
6. Run the app on an emulator or physical device
26+
### 📊 3. Live Mandi Market Intelligence & Price Ticker
27+
* **Real-time Government API Ingestion**: Direct integration with `data.gov.in` Mandi APIs featuring key rotation and failover mechanisms.
28+
* **Multi-language Support**: Instant translation support (English, Hindi, Telugu, Tamil, Marathi).
29+
* **Price Drop & Surge Alerts**: Automated background notifications via Android `WorkManager` for critical price spikes and severe localized weather events.
30+
31+
### 🚜 4. Smart Tractor Autopilot & Telemetry Controls
32+
* **Autonomous Guidance Controls**: A-B line navigation mode, speed throttling, compass heading calculations, and coverage tracking.
33+
* **Edge Watchdog & Circuit Breaker**: Resilience layer for IoT telemetry streaming across Wi-Fi, GSM, and LoRa networks.
34+
35+
### 💰 5. Agricultural Loan & Financial Planner
36+
* **Kisan Credit Card (KCC) Eligibility Calculator**: Computes scale of finance based on land acreage, crop type, and subsidized interest rates.
37+
* **PM-KISAN Scheme Tracker**: Financial breakdown for agricultural subsidies and crop insurance (PMFBY).
38+
39+
---
40+
41+
## 🏗 System Architecture
42+
43+
```mermaid
44+
graph TD
45+
A[Mobile Farmer App - Android Jetpack Compose] -->|Auth & User Sync| B[Supabase Backend Service]
46+
A -->|Vision Analysis & LLM Queries| C[Groq AI Inference Cloud]
47+
A -->|Live Rates & Failover| D[Gov Mandi API / Local Node.js Gateway]
48+
E[Web Management Portal - React + Vite] -->|Enterprise Dashboard| B
49+
F[Edge IoT Gateway / Telemetry] -->|Mqtt / GSM| D
50+
```
51+
52+
---
53+
54+
## 🛠 Tech Stack & Versions
55+
56+
| Layer | Component | Technologies & Versions |
57+
| :--- | :--- | :--- |
58+
| **Mobile App** | UI Framework | Android Jetpack Compose, Material 3, Kotlin 2.0.21 |
59+
| **Mobile App** | Architecture | MVVM, Coroutines, StateFlow, Room DB v2.6.1, KSP |
60+
| **Mobile App** | Vision & Camera | CameraX (v1.4.1), TensorFlow Lite (v2.16.1), Coil |
61+
| **Network & Auth**| Authentication | Supabase Kotlin Auth (`io.github.jan-tennert.supabase:auth-kt:3.1.4`) |
62+
| **Network & Auth**| REST & Async | OkHttp 4.12.0, Ktor Client Android, Serialization |
63+
| **Backend API** | Server & Middleware | Node.js v20, TypeScript, Fastify / Express, Redis |
64+
| **Web Dashboard** | Frontend | React 18, Vite, TypeScript, TailwindCSS |
65+
66+
---
67+
68+
## 📦 Project Directory Structure
69+
70+
```
71+
agriculture-ai-os/
72+
├── app/ # Android Native Jetpack Compose Application
73+
│ ├── src/main/java/com/example/
74+
│ │ ├── AuthViewModel.kt # Supabase Session & Auth Management
75+
│ │ ├── GeminiVisionService.kt # Groq Vision LLM API Pipeline
76+
│ │ ├── DiseaseScannerScreen.kt # CameraX AI Scanning UI
77+
│ │ ├── HomeScreen.kt # Primary Farmer Operating Dashboard
78+
│ │ ├── MandiApiService.kt # Live Market Rates & Key Rotation
79+
│ │ ├── SupabaseClient.kt # Supabase Client Initializer
80+
│ │ └── ...
81+
│ └── build.gradle.kts
82+
├── backend/ # Node.js TypeScript API Gateway & Telemetry Service
83+
│ ├── src/
84+
│ ├── docker-compose.yml
85+
│ └── package.json
86+
├── web/ # React + Vite Enterprise Web Portal
87+
│ ├── src/
88+
│ └── package.json
89+
├── build.gradle.kts # Root Project Gradle Configuration
90+
├── settings.gradle.kts
91+
└── README.md
92+
```
93+
94+
---
95+
96+
## ⚙️ Setup & Building Instructions
97+
98+
### 📱 Android Application (Mobile)
99+
100+
#### Prerequisites:
101+
* **JDK**: OpenJDK 17 or Android Studio Bundled JBR
102+
* **Android Studio**: Ladybug / Koala or newer (SDK 34+)
103+
104+
#### Steps:
105+
1. **Clone the repository**:
106+
```bash
107+
git clone https://github.com/JACK-AI7/NuKropAI.git
108+
cd NuKropAI
109+
```
110+
2. **Build Release APK**:
111+
```bash
112+
./gradlew assembleRelease --no-daemon
113+
```
114+
3. The generated release APK will be located at:
115+
`app/build/outputs/apk/release/app-release.apk`
116+
117+
---
118+
119+
### 🖥️ Backend Service (Node.js)
120+
121+
1. **Navigate to the backend directory**:
122+
```bash
123+
cd backend
124+
```
125+
2. **Install dependencies**:
126+
```bash
127+
npm install
128+
```
129+
3. **Start Development Server**:
130+
```bash
131+
npm run dev
132+
```
133+
134+
---
135+
136+
### 🌐 Web Dashboard (React + Vite)
137+
138+
1. **Navigate to the web directory**:
139+
```bash
140+
cd web
141+
```
142+
2. **Install dependencies**:
143+
```bash
144+
npm install
145+
```
146+
3. **Launch Dev Server**:
147+
```bash
148+
npm run dev
149+
```
150+
151+
---
152+
153+
## 📄 License & Release Notes
154+
155+
* **Version**: `1.0.0`
156+
* **Release Date**: August 2026
157+
* **Maintainer**: NuKropAI Core Engineering Team
158+
* **License**: MIT License

0 commit comments

Comments
 (0)