deadshot2003 commited on
Commit
61e6b14
·
verified ·
1 Parent(s): 86463fc

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +72 -0
README.md CHANGED
@@ -9,5 +9,77 @@ app_file: app.py
9
  pinned: false
10
  license: apache-2.0
11
  ---
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
12
 
13
  Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
 
9
  pinned: false
10
  license: apache-2.0
11
  ---
12
+ # LabelWise: An AI-powered Food Label Analyzer
13
+
14
+ [Visit the live app here!](https://deadshot2003-food-label-analyzer.hf.space)
15
+
16
+ **LabelWise** is an intelligent tool that helps users make informed food choices by analyzing product labels based on their individual health profiles. By using cutting-edge AI, the app evaluates the nutritional content of products and provides users with a personalized health rating, helping them align their food consumption with their health goals.
17
+
18
+ ## Features
19
+
20
+ - **User Registration and Profile Setup**:
21
+ - Register by providing your name, email, password, age, height, weight (BMI auto-calculated), health conditions, allergies, activity level, food preferences, and health goals.
22
+ - Edit your profile anytime to ensure recommendations are always relevant.
23
+
24
+ - **Login and Personal Dashboard**:
25
+ - Secure login with email and password. Access your personalized dashboard with options to edit your profile, analyze products, and more.
26
+
27
+ - **AI-Powered Label Analysis**:
28
+ - Upload the back label of any product, and our AI model analyzes it against your health profile.
29
+ - Get instant feedback including a health rating based on nutritional data and your individual preferences.
30
+
31
+ - **Database Recognition**:
32
+ - If the product is already in our database, get instant access to its details.
33
+ - If it's new, answer two simple questions: product type and consumption frequency.
34
+
35
+ - **Multilingual Support**:
36
+ - Translate AI analysis into any world language and most Indian regional languages for easy comprehension.
37
+
38
+ - **Health Ratings**:
39
+ - Receive a personalized health rating for each product based on your profile and its nutritional content.
40
+
41
+ - **Logout**:
42
+ - Easily logout and secure your information when done.
43
+
44
+ give the whole thing is a .md file format like install dependencies then enviorment setup, running the application
45
+
46
+
47
+ # LabelWise: Getting Started Guide
48
+
49
+
50
+
51
+ ## 1. Clone the Repository
52
+
53
+ To get started, clone the LabelWise repository to your local machine:
54
+
55
+ ```sh
56
+ git clone https://github.com/yourusername/LabelWise.git
57
+ cd LabelWise
58
+ ```
59
+ ##2. Install Dependencies
60
+ Ensure you have Python installed on your system. Then, install the required Python packages using pip:
61
+ ```sh
62
+ pip install -r requirements.txt
63
+ ```
64
+ 3. Environment Setup
65
+ LabelWise requires some environment variables to be set up for MongoDB Atlas and other API keys.
66
+
67
+ Create a .env file in the root directory of your project. Add your MongoDB connection string and any other necessary secret keys to the .env file.
68
+
69
+ Example .env file contents:
70
+
71
+ ```sh
72
+ MONGODB_URI=your_mongodb_uri
73
+ SECRET_KEY=your_secret_key
74
+ ```
75
+ 4. Running the Application
76
+ Once you've completed the setup and installed all required dependencies, you can run the LabelWise application using Streamlit:
77
+
78
+ ```sh
79
+ streamlit run app.py
80
+ ```
81
+ This command will start the application and open it in your default web browser.
82
+
83
+ Feel free to reach out if you have any questions or need further assistance.
84
 
85
  Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference