NutriGuard - SDG 2 Zero Hunger Initiative

A comprehensive food security platform leveraging AI technology to address SDG 2 (Zero Hunger) through innovative nutrition analysis, crop prediction, and community support systems.

🌟 Features

🤖 AI-Powered Solutions

Nutrition Analysis: Advanced AI-driven meal analysis using OpenAI GPT models
Crop Yield Prediction: Machine learning-based agricultural forecasting
Personalized Recommendations: Tailored advice based on user profiles
Real-time Analytics: Comprehensive food security insights

💳 Secure Payment Integration

IntaSend Gateway: Seamless mobile money and card payments
Donation Platform: Support food security initiatives
Marketplace: Direct farmer-to-consumer transactions
Multi-currency Support: KES, USD, EUR, GBP

🔐 Enterprise Security

JWT Authentication: Secure token-based authentication
Rate Limiting: Protection against abuse and attacks
Input Validation: Comprehensive data sanitization
CSRF Protection: Cross-site request forgery prevention
SQL Injection Prevention: Parameterized queries and ORM

📱 Modern UI/UX

Responsive Design: Mobile-first approach
Progressive Web App: Offline capabilities
Accessibility: WCAG 2.1 compliant
Real-time Updates: WebSocket integration
Multi-language Support: Internationalization ready

🏗️ Architecture

Technology Stack

Backend: Python 3.8+, Flask 2.3+
Database: MySQL 8.0+ with Redis caching
Frontend: HTML5, CSS3, Vanilla JavaScript
AI Services: OpenAI GPT-3.5/4, Hugging Face Transformers
Payment: IntaSend API integration
Deployment: Gunicorn, Nginx, Docker (optional)

System Requirements

Python 3.8 or higher
MySQL 8.0 or higher
Redis 6.0+ (recommended)
2GB RAM minimum (4GB recommended)
10GB disk space

🚀 Quick Start

1. Clone the Repository

git clone https://github.com/yourusername/nutriguard.git
cd nutriguard

2. Environment Setup

# Create virtual environment
python -m venv venv
source venv/bin/activate  # On Windows: venv\Scripts\activate

# Install dependencies
pip install -r requirements.txt

3. Database Setup

# Create MySQL database
mysql -u root -p
CREATE DATABASE nutriguard;
exit

# Run database schema
mysql -u root -p nutriguard < database_setup.sql

4. Configuration

# Copy environment template
cp .env.example .env

# Edit .env with your configuration
nano .env

5. Run the Application

# Development mode
python app.py

# Production mode
gunicorn --config gunicorn.conf.py app:app

⚙️ Configuration

Environment Variables

Variable	Description	Required	Default
`SECRET_KEY`	Flask secret key	Yes	-
`DATABASE_URL`	MySQL connection string	Yes	-
`OPENAI_API_KEY`	OpenAI API key	Yes	-
`INTASEND_PUBLIC_KEY`	IntaSend public key	Yes	-
`INTASEND_SECRET_KEY`	IntaSend secret key	Yes	-
`REDIS_URL`	Redis connection string	No	`redis://localhost:6379/0`
`FLASK_ENV`	Environment mode	No	`development`

Database Configuration

# Example DATABASE_URL formats
mysql://username:password@localhost/nutriguard
mysql://user:pass@hostname:3306/dbname

API Keys Setup

OpenAI: Get your API key from OpenAI Platform
IntaSend: Register at IntaSend and get your keys
Hugging Face (optional): Get token from Hugging Face

🧪 Testing

Run Test Suite

# Run all tests
python test_suite.py

# Run specific test class
python -m unittest test_suite.TestAuthentication

# Run with coverage
pip install coverage
coverage run test_suite.py
coverage report

Test Categories

Authentication Tests: User registration, login, JWT tokens
AI Service Tests: Nutrition analysis, crop prediction
Payment Tests: IntaSend integration, donation processing
Security Tests: Input validation, rate limiting
API Tests: Endpoint functionality, error handling

📊 API Documentation

Authentication Endpoints

Register User

POST /api/register
Content-Type: application/json

{
    "username": "farmer1",
    "email": "farmer@example.com",
    "password": "securepassword",
    "user_type": "farmer",
    "location": "Nairobi, Kenya",
    "phone": "254712345678"
}

Login

POST /api/login
Content-Type: application/json

{
    "username": "farmer1",
    "password": "securepassword"
}

AI Services

Nutrition Analysis

POST /api/nutrition/analyze
Authorization: Bearer <token>
Content-Type: application/json

{
    "meal_description": "Grilled chicken with steamed vegetables and brown rice"
}

Crop Prediction

POST /api/crops/predict
Authorization: Bearer <token>
Content-Type: application/json

{
    "crop_type": "maize",
    "location": "Nairobi, Kenya",
    "soil_data": {
        "type": "loamy",
        "ph": 6.5,
        "organic_matter": "high"
    },
    "weather_data": {
        "expected_rainfall": 800,
        "temperature_range": "20-30°C"
    }
}

Payment Endpoints

Initiate Donation

POST /api/donate
Authorization: Bearer <token>
Content-Type: application/json

{
    "amount": 1000,
    "phone_number": "254712345678",
    "purpose": "Support smallholder farmers"
}

🔧 Deployment

Automated Deployment

# Run deployment script
python deploy.py --environment production

# Or for development
python deploy.py --environment development

Manual Production Setup

1. Web Server (Nginx)

server {
    listen 80;
    server_name yourdomain.com;

    location / {
        proxy_pass http://127.0.0.1:5000;
        proxy_set_header Host $host;
        proxy_set_header X-Real-IP $remote_addr;
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
    }

    location /static {
        alias /path/to/nutriguard/static;
        expires 1y;
        add_header Cache-Control "public, immutable";
    }
}

2. SSL Certificate (Let's Encrypt)

sudo certbot --nginx -d yourdomain.com

3. Systemd Service

sudo cp nutriguard.service /etc/systemd/system/
sudo systemctl enable nutriguard
sudo systemctl start nutriguard

Docker Deployment (Optional)

FROM python:3.9-slim

WORKDIR /app
COPY requirements.txt .
RUN pip install -r requirements.txt

COPY . .
EXPOSE 5000

CMD ["gunicorn", "--config", "gunicorn.conf.py", "app:app"]

📈 Monitoring and Analytics

Health Checks

/health - Application health status
/metrics - Prometheus metrics (if enabled)
Database connection monitoring
Redis connection status

Logging

Application logs: logs/app.log
Access logs: logs/access.log
Error logs: logs/error.log
Deployment logs: deployment.log

Performance Monitoring

Response time tracking
Database query performance
AI service latency
Payment processing metrics

🤝 Contributing

Development Setup

Fork the repository
Create a feature branch: git checkout -b feature/amazing-feature
Install development dependencies: pip install -r requirements-dev.txt
Make your changes
Run tests: python test_suite.py
Commit changes: git commit -m 'Add amazing feature'
Push to branch: git push origin feature/amazing-feature
Open a Pull Request

Code Standards

Follow PEP 8 style guidelines
Write comprehensive docstrings
Add unit tests for new features
Update documentation as needed
Use type hints where appropriate

Testing Guidelines

Maintain >90% test coverage
Write both unit and integration tests
Mock external API calls
Test error conditions
Validate security measures

🔒 Security

Security Measures Implemented

Authentication: JWT tokens with expiration
Authorization: Role-based access control
Input Validation: Comprehensive sanitization
SQL Injection: Parameterized queries
XSS Protection: Content Security Policy
CSRF Protection: Token validation
Rate Limiting: Request throttling
HTTPS Enforcement: SSL/TLS encryption

Security Best Practices

Regular dependency updates
Security header implementation
Secure cookie configuration
Password strength requirements
Session management
Audit logging

📚 Documentation

Additional Resources

SDG 2 Alignment

NutriGuard directly supports UN Sustainable Development Goal 2 (Zero Hunger) by:

Improving nutrition through AI-powered meal analysis
Supporting smallholder farmers with crop prediction
Facilitating food access through marketplace integration
Enabling community support through donation platform
Promoting sustainable agriculture practices

🌍 Impact Metrics

Key Performance Indicators

Users registered and active
Nutrition analyses completed
Crop predictions generated
Donations processed
Farmers supported
Lives impacted

Success Stories

Improved crop yields for smallholder farmers
Better nutrition awareness in communities
Successful donation campaigns
Marketplace transaction growth

📞 Support

Getting Help

Documentation: Check this README and docs folder
Issues: Open a GitHub issue for bugs or feature requests
Discussions: Use GitHub Discussions for questions
Email: contact@nutriguard.com (if applicable)

Community

Join our community discussions
Follow us on social media
Contribute to the project
Share your success stories

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

🙏 Acknowledgments

UN SDG 2: Zero Hunger initiative inspiration
OpenAI: AI-powered nutrition analysis
IntaSend: Payment processing partnership
Flask Community: Web framework support
Contributors: All developers who contributed to this project

Built with ❤️ for SDG 2 Zero Hunger Initiative

"Technology for a hunger-free world"

Name		Name	Last commit message	Last commit date
.github		.github
__pycache__		__pycache__
api		api
reports		reports
static		static
templates		templates
.coverage		.coverage
.env.example		.env.example
.gitignore		.gitignore
PROJECT_SUMMARY.md		PROJECT_SUMMARY.md
README.md		README.md
ai_services.py		ai_services.py
app.py		app.py
config.py		config.py
coverage.xml		coverage.xml
database_setup.sql		database_setup.sql
demo_data.py		demo_data.py
deploy.py		deploy.py
deployment.log		deployment.log
gunicorn.conf.py		gunicorn.conf.py
payment_service.py		payment_service.py
requirements.txt		requirements.txt
run_tests.py		run_tests.py
security.py		security.py
test_suite.py		test_suite.py
vercel.json		vercel.json

Uh oh!

Latest commit

History

Folders and files

Repository files navigation