Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
89 changes: 89 additions & 0 deletions QUICKSTART.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,89 @@
# AgriTech Project - Quick Start Guide

## ✅ Dependencies Installed

All Python dependencies from requirements.txt are installed in the virtual environment at `.venv/`

## 🚀 Running the Project

### Start Backend (Flask API)

```powershell
.\start_backend.ps1
```

**Backend URL:** http://localhost:5000

### Start Frontend (Static Server)

```powershell
python -m http.server 8080
```

**Frontend URL:** http://localhost:8080

## 📝 Configuration

Environment variables are stored in `.env` file:

- `GEMINI_API_KEY` - Google Gemini API key
- `FIREBASE_*` - Firebase configuration

Update these values in `.env` file for production use.

## 🔍 Accessing the Application

- **Home Page:** http://localhost:8080/index.html
- **About:** http://localhost:8080/about.html
- **Blog:** http://localhost:8080/blog.html
- **Contact:** http://localhost:8080/contact.html
- **Firebase Config API:** http://localhost:5000/api/firebase-config

## ✨ Features

- ✓ All dependencies installed
- ✓ Virtual environment configured
- ✓ Environment variables set
- ✓ Backend Flask server running (port 5000)
- ✓ Frontend static server running (port 8080)
- ✓ Accessibility improvements applied (skip links, landmarks, proper headings)

## 🛠️ Project Structure

```
AgriTechSwoc/
├── app.py # Flask backend
├── start_backend.ps1 # Backend startup script
├── .env # Environment variables
├── requirements.txt # Python dependencies
├── .venv/ # Virtual environment
├── index.html # Home page
├── about.html # About page
├── blog.html # Blog page
├── contact.html # Contact page
└── ... (other pages)
```

## 🔧 Troubleshooting

If you encounter issues:

1. **Backend not starting:** Check `.env` file exists and has proper values
2. **Port conflicts:** Change ports in startup commands if 5000/8080 are in use
3. **Import errors:** Ensure virtual environment is activated: `.venv/Scripts/activate`

## 📦 Installed Packages

Key packages installed:

- Flask & Flask-CORS (Web framework)
- google-generativeai (AI integration)
- PyJWT & bcrypt (Security)
- TensorFlow, Keras, PyTorch (ML models)
- scikit-learn, xgboost, catboost (ML libraries)
- streamlit (Data apps)
- And 100+ more dependencies

---

**Project Status:** ✅ Running error-free
Loading
Loading