Skip to content

Commit 6f470be

Browse files
committed
Add readme
1 parent d1c3ce0 commit 6f470be

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -76,13 +76,13 @@ The application is designed to be user-friendly and interactive, allowing users
7676
+--------------------------------------+
7777
```
7878
79-
# Project Structure
79+
## Project Structure
8080
8181
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.
8282
8383
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.
8484
85-
## Backend
85+
### Backend
8686
8787
The `backend` directory contains everything related to the FastAPI application. Here's the structure of the `backend` directory:
8888
@@ -101,7 +101,7 @@ backend/
101101
├── requirements.txt
102102
```
103103
104-
### Files
104+
#### Files
105105
106106
- **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.
107107
- **k8s/deployment.yaml**: This is the Kubernetes configuration file for the backend Deployment.
@@ -111,7 +111,7 @@ backend/
111111
- **Dockerfile**: This file defines how the Docker image for the FastAPI application is built.
112112
- **requirements.txt**: This file lists the Python dependencies required for the FastAPI application.
113113
114-
## Frontend
114+
### Frontend
115115
116116
The `frontend` directory contains everything related to the Streamlit application. Here's the structure of the `frontend` directory:
117117
@@ -130,7 +130,7 @@ frontend/
130130
├── requirements.txt
131131
```
132132
133-
### Files
133+
#### Files
134134
135135
- **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.
136136
- **k8s/deployment.yaml**: This is the Kubernetes configuration file for the frontend Deployment.
@@ -141,7 +141,7 @@ frontend/
141141
- **Readme.md**: Documentation file for the frontend application.
142142
- **requirements.txt**: This file lists the Python dependencies required for the Streamlit web application.
143143
144-
## Root Directory
144+
### Root Directory
145145
146146
The root directory contains configuration files and documentation for the overall project:
147147
@@ -154,7 +154,7 @@ The root directory contains configuration files and documentation for the overal
154154
├── README.md
155155
```
156156
157-
### Files
157+
#### Files
158158
159159
- **.github/**: Contains GitHub configuration files. Includes workflows for CI/CD integration with GitHub Actions.
160160
- **.gitignore**: Git ignore file.
@@ -284,7 +284,7 @@ To deploy the services with Docker Compose, follow these steps:
284284
docker-compose down
285285
```
286286

287-
##### Option2: GitHub Container Registry Images with Docker Compose
287+
##### Option 2: GitHub Container Registry Images with Docker Compose
288288

289289
To deploy the services with Docker Compose using GitHub Container Registry images, follow these steps:
290290

0 commit comments

Comments
 (0)