You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+8-8Lines changed: 8 additions & 8 deletions
Original file line number
Diff line number
Diff line change
@@ -76,13 +76,13 @@ The application is designed to be user-friendly and interactive, allowing users
76
76
+--------------------------------------+
77
77
```
78
78
79
-
# Project Structure
79
+
## Project Structure
80
80
81
81
The project structure is organized into two main directories: `backend` and `frontend`. In root directory, you can find the configuration files and documentation for the overall project.
82
82
83
83
The project structure is designed to separate the backend and frontend components of the application, making it easier to manage and deploy each part independently. The `backend` directory contains the FastAPI application code, while the `frontend` directory contains the Streamlit application code. The root directory contains common configuration files and documentation for the entire project.
84
84
85
-
## Backend
85
+
### Backend
86
86
87
87
The `backend` directory contains everything related to the FastAPI application. Here's the structure of the `backend` directory:
88
88
@@ -101,7 +101,7 @@ backend/
101
101
├── requirements.txt
102
102
```
103
103
104
-
### Files
104
+
#### Files
105
105
106
106
- **api/main.py**: This is the main file for the FastAPI application. It's where the API is defined and the language model is loaded.
107
107
- **k8s/deployment.yaml**: This is the Kubernetes configuration file for the backend Deployment.
@@ -111,7 +111,7 @@ backend/
111
111
- **Dockerfile**: This file defines how the Docker image for the FastAPI application is built.
112
112
- **requirements.txt**: This file lists the Python dependencies required for the FastAPI application.
113
113
114
-
## Frontend
114
+
### Frontend
115
115
116
116
The `frontend` directory contains everything related to the Streamlit application. Here's the structure of the `frontend` directory:
117
117
@@ -130,7 +130,7 @@ frontend/
130
130
├── requirements.txt
131
131
```
132
132
133
-
### Files
133
+
#### Files
134
134
135
135
- **app/main.py**: This is the main file for the Streamlit application. It's where the user interface is defined and interacts with the backend API.
136
136
- **k8s/deployment.yaml**: This is the Kubernetes configuration file for the frontend Deployment.
@@ -141,7 +141,7 @@ frontend/
141
141
- **Readme.md**: Documentation file for the frontend application.
142
142
- **requirements.txt**: This file lists the Python dependencies required for the Streamlit web application.
143
143
144
-
## Root Directory
144
+
### Root Directory
145
145
146
146
The root directory contains configuration files and documentation for the overall project:
147
147
@@ -154,7 +154,7 @@ The root directory contains configuration files and documentation for the overal
154
154
├── README.md
155
155
```
156
156
157
-
### Files
157
+
#### Files
158
158
159
159
- **.github/**: Contains GitHub configuration files. Includes workflows for CI/CD integration with GitHub Actions.
160
160
- **.gitignore**: Git ignore file.
@@ -284,7 +284,7 @@ To deploy the services with Docker Compose, follow these steps:
284
284
docker-compose down
285
285
```
286
286
287
-
##### Option2: GitHub Container Registry Images with Docker Compose
287
+
##### Option 2: GitHub Container Registry Images with Docker Compose
288
288
289
289
To deploy the services with Docker Compose using GitHub Container Registry images, follow these steps:
0 commit comments