Skip to content

Commit dcb2ac3

Browse files
authored
Update README.md
Added folder structure
1 parent 5b16c01 commit dcb2ac3

File tree

1 file changed

+33
-0
lines changed

1 file changed

+33
-0
lines changed

β€ŽREADME.mdβ€Ž

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,39 @@ This API enables ingestion of text data, which is embedded via OpenAI's `text-em
2626

2727
---
2828

29+
## πŸ“ Project Structure
30+
31+
```
32+
second-brain/
33+
β”œβ”€β”€ app/
34+
β”‚ β”œβ”€β”€ main.py
35+
β”‚ β”œβ”€β”€ router.py
36+
β”‚ β”œβ”€β”€ auth.py
37+
β”‚ β”œβ”€β”€ config.py
38+
β”‚ β”œβ”€β”€ qdrant_client.py
39+
β”‚ └── utils/
40+
β”‚ β”œβ”€β”€ logger.py
41+
β”‚ └── openai_client.py
42+
β”œβ”€β”€ tests/
43+
β”‚ β”œβ”€β”€ __init__.py
44+
β”‚ β”œβ”€β”€ test_health.py
45+
β”‚ β”œβ”€β”€ test_ingest.py
46+
β”‚ └── test_search.py
47+
β”œβ”€β”€ docs/
48+
β”‚ β”œβ”€β”€ USAGE.md
49+
β”‚ β”œβ”€β”€ ARCHITECTURE.md
50+
β”‚ └── CHANGE_AUDIT.md
51+
β”œβ”€β”€ logs/ # Log files (gitignored)
52+
β”œβ”€β”€ qdrant_data/ # Persistent data for Qdrant (gitignored)
53+
β”œβ”€β”€ docker-compose.yml
54+
β”œβ”€β”€ Makefile
55+
β”œβ”€β”€ requirements.txt
56+
β”œβ”€β”€ .gitignore
57+
β”œβ”€β”€ LICENSE
58+
└── README.md
59+
```
60+
---
61+
2962
## πŸ”§ Setup
3063

3164
1. Clone the repo:

0 commit comments

Comments
Β (0)