Skip to content

README.md

Latest commit

 

History

History
231 lines (186 loc) · 6.6 KB

README.md

File metadata and controls

231 lines (186 loc) · 6.6 KB

NutriClassify 🍲

A mobile-first React Native application that intelligently categorizes Nigerian and African cuisine by their nutritional class, health benefits, and recipe suggestions, empowering users to make informed dietary choices.

📱 Features

1. Food Database Module

  • Comprehensive database of Nigerian and African foods
  • Detailed nutritional information including macronutrients and micronutrients
  • Local names in Yoruba, Igbo, and Hausa
  • Health benefits for each food item
  • Categorization by food groups and nutritional classes
  • Calorie and serving size information

2. Recipe Module

  • Collection of traditional Nigerian recipes
  • Nutritional tags for easy filtering (High Protein, High Fiber, etc.)
  • Step-by-step cooking instructions with progress tracking
  • Ingredient lists with shopping list integration
  • Difficulty levels and cooking times
  • Meal type categorization (Breakfast, Lunch, Dinner, Snack)

3. Nutrition Education Module

  • Interactive learning topics about nutrition
  • African food context for each topic
  • Progress tracking system
  • Topics include:
    • Understanding Macronutrients
    • Essential Vitamins
    • Important Minerals
    • Dietary Fiber Benefits
    • Protein for Growth
    • Healthy vs Unhealthy Fats
    • Importance of Hydration
    • Creating Balanced Meals

4. Search & Filtering

  • Global search across foods and recipes
  • Filter by nutritional class
  • Filter by food category
  • Filter by meal type and difficulty
  • Popular search suggestions

5. Profile & Tracking

  • Daily nutrition tracking with visual charts
  • Food logging with serving sizes
  • Weekly calorie trends visualization
  • Shopping list management with check-off functionality
  • Favorite foods and recipes
  • Progress tracking for nutrition goals

🚀 Getting Started

Prerequisites

  • Node.js (v18 or higher)
  • pnpm package manager
  • Expo CLI
  • Expo Go app on your mobile device

Installation

  1. Clone the repository:
git clone https://github.com/Blockahin-Oracle/NutriClassify.git
cd NutriClassify
  1. Install dependencies:
pnpm install
  1. Start the development server:
pnpm expo start
  1. Scan the QR code with Expo Go app on your phone

Running on Different Platforms

iOS Simulator (Mac only):

pnpm expo start --ios

Android Emulator:

pnpm expo start --android

Web Browser (Development):

pnpm expo start --web

🛠️ Tech Stack

  • React Native with Expo - Mobile app framework
  • TypeScript - Type-safe JavaScript
  • React Navigation - Navigation library with bottom tabs
  • Zustand - Lightweight state management
  • AsyncStorage - Local data persistence
  • React Native Elements & React Native Paper - UI components
  • React Native Chart Kit - Data visualization
  • @expo/vector-icons - Icon library

📂 Project Structure

NutriClassify/
├── src/
│   ├── components/          # Reusable UI components
│   │   ├── Card.tsx
│   │   ├── SearchInput.tsx
│   │   └── FilterChip.tsx
│   ├── screens/            # Screen components
│   │   ├── FoodListScreen.tsx
│   │   ├── FoodDetailScreen.tsx
│   │   ├── RecipeListScreen.tsx
│   │   ├── RecipeDetailScreen.tsx
│   │   ├── NutritionEducationScreen.tsx
│   │   ├── ProfileScreen.tsx
│   │   └── SearchScreen.tsx
│   ├── navigation/         # Navigation configuration
│   │   └── AppNavigator.tsx
│   ├── data/              # Food and recipe databases
│   │   ├── nigerianFoods.ts
│   │   └── recipes.ts
│   ├── store/             # State management
│   │   └── useStore.ts
│   ├── types/             # TypeScript type definitions
│   │   └── index.ts
│   └── utils/             # Utility functions
├── App.tsx                # Main app component
├── package.json
├── tsconfig.json
└── README.md

🍽️ Nigerian Food Database

The app includes a comprehensive database of Nigerian foods:

  • Staples: Garri, Jollof Rice, Yam, Plantain
  • Proteins: Egusi, Black-eyed Peas, Catfish
  • Vegetables: Okra, Bitter Leaf, Moringa
  • Others: Palm Oil, Tiger Nuts, and more

Each food item includes:

  • Complete nutritional profile
  • Local names in major Nigerian languages
  • Health benefits
  • Serving sizes and calorie information

🥘 Recipe Collection

Traditional Nigerian recipes including:

  • Jollof Rice - The party favorite
  • Egusi Soup - Melon seed delicacy
  • Akara - Bean cakes
  • Moin Moin - Steamed bean pudding
  • Plantain Porridge - Comfort food
  • Okra Soup - Nutritious and delicious
  • Zobo Drink - Refreshing hibiscus tea
  • Chin Chin - Crunchy snack

📊 Nutritional Classification System

Foods are intelligently classified by:

  • High Protein - For muscle building
  • High Fiber - For digestive health
  • High Carbohydrate - For energy
  • Low Fat / High Fat - For dietary preferences
  • Antioxidant Rich - For cellular health
  • Vitamin Rich - For immunity
  • Mineral Rich - For body functions
  • Whole Food - For natural nutrition

🎯 Key Features Implementation

Smart Search

  • Search by food name, local names, or health benefits
  • Filter by nutritional requirements
  • Quick access to frequently searched items

Interactive Education

  • Bite-sized learning modules
  • Progress tracking
  • African food examples for each concept
  • Visual learning with icons and colors

Shopping List Management

  • Add ingredients from recipes
  • Check off items while shopping
  • Clear completed items
  • Persistent storage

🔮 Future Enhancements

  • User authentication and cloud sync
  • Barcode scanning for packaged foods
  • Meal planning and scheduling
  • Community recipe sharing
  • Integration with fitness trackers
  • Offline-first architecture
  • More African cuisines (Ghanaian, Kenyan, etc.)
  • AI-powered meal recommendations
  • Nutritionist consultation booking

🤝 Contributing

Contributions are welcome! Please feel free to submit pull requests or open issues for bugs and feature requests.

📄 License

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

👏 Acknowledgments

  • Built for the African community to promote healthy eating with traditional foods
  • Nutritional data compiled from verified sources
  • Icons from @expo/vector-icons
  • UI components from React Native Elements

📞 Contact

For questions, suggestions, or collaborations, please open an issue on GitHub.

Made with ❤️ for healthy African cuisine