shaileshjadhavSS commited on
Commit
07b0dc7
·
1 Parent(s): 2a10102

Updated readme

Browse files
Files changed (1) hide show
  1. README.md +13 -74
README.md CHANGED
@@ -1,74 +1,13 @@
1
- # iConcierge Chatbot
2
- The iConcierge chatbot is designed to assist users in tracking their meals, identifying recent meals, providing nutritional information, and suggesting the next meal of the day. The chatbot takes into account the user's profile, meal history, and other relevant factors to offer personalized meal suggestions.
3
-
4
- ## Clone the repository
5
- Clone the repository:
6
- ```
7
- $ git clone https://nonstop-development@bitbucket.org/nonstopio-dev/iconcierge.git
8
-
9
- $ cd iconcierge
10
- ```
11
-
12
- ## Installation
13
-
14
- ### Environment Configuration
15
- First, create an env.sh file with the following content to set up your
16
- environment variables:
17
-
18
- ```
19
- export GOOGLE_API_KEY="API_KEY"
20
- export DB_NAME="DATABASE_NAME"
21
- export DB_USER="USERNAME"
22
- export DB_PASSWORD="PASSWORD"
23
- export DB_HOST="localhost"
24
- export DB_PORT="5432"
25
- export CLOUDINARY_CLOUD_NAME="CLOUD_NAM"
26
- export CLOUDINARY_API_KEY="CLOUDINARY_API_KEY"
27
- export CLOUDINARY_API_SECRET="CLOUDINARY_API_SECRET"
28
- ```
29
-
30
- To apply these environment variables, run the following command in your console:
31
- ```
32
- source env.sh
33
- ```
34
-
35
- ### Package Installation
36
-
37
- Next, install the required packages by running:
38
- ```
39
- pip install -r requirements.txt
40
- ```
41
-
42
- ### Execution
43
- To run the iConcierge chatbot application, use the following command:
44
- ```
45
- streamlit run app.py
46
- ```
47
- The application will be available at http://localhost:8501.
48
-
49
-
50
- ## Docker Setup
51
-
52
- ## Prerequisites
53
- To run this project using Docker, you need to have Docker installed on your machine. You can download and install Docker from the official Docker installation guide.
54
-
55
- ## Installation
56
-
57
- ## Build the Docker Image
58
- Build the Docker image using the following command:
59
- ```
60
- docker build -t <image_name> .
61
- ```
62
-
63
- ## Run the Docker Container
64
- Run the Docker container with the following command:
65
- ```
66
- docker run -p 8501:8501 <image_name>
67
- ```
68
- The application will be available at http://localhost:8501.
69
-
70
- ## PostgreSQL (User Details)
71
- We used Retool PostgreSQL to store user details, ensuring efficient and secure management of user data. Make sure your PostgreSQL database is properly configured and the credentials are correctly set in the env.sh file.
72
-
73
- For more detailed documentation on how to configure and manage your PostgreSQL database, refer to the [official PostgreSQL documentation](https://www.postgresql.org/docs/).
74
-
 
1
+ ---
2
+ title: WellnessAI
3
+ emoji: 🚀
4
+ colorFrom: purple
5
+ colorTo: indigo
6
+ sdk: streamlit
7
+ sdk_version: 1.36.0
8
+ 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