Skip to content

Commit d064496

Browse files
authored
Update README.md
1 parent 915813b commit d064496

File tree

1 file changed

+40
-19
lines changed

1 file changed

+40
-19
lines changed

README.md

Lines changed: 40 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,9 @@ This is a tutorial project of [Pocket Flow](https://github.com/The-Pocket/Pocket
1818

1919
- Check out the [Substack Post Tutorial](https://zacharyhuang.substack.com/p/ai-codebase-knowledge-builder-full) for more!
2020

21-
  **🔸 🎉 Reached Hacker News Front Page** (April 2025) with >800 up‑votes: [Discussion »](https://news.ycombinator.com/item?id=43739456)
21+
  **🔸 🎉 Reached Hacker News Front Page** (April 2025) with >900 up‑votes: [Discussion »](https://news.ycombinator.com/item?id=43739456)
22+
23+
  **🔸 🎊 Online Service Now Live!** (May 2025) Just paste a GitHub link, no installation needed! [https://code2tutorial.com/](https://code2tutorial.com/)
2224

2325
## ⭐ Example Results for Popular GitHub Repositories!
2426

@@ -123,6 +125,43 @@ This is a tutorial project of [Pocket Flow](https://github.com/The-Pocket/Pocket
123125
The application will crawl the repository, analyze the codebase structure, generate tutorial content in the specified language, and save the output in the specified directory (default: ./output).
124126

125127

128+
<details>
129+
130+
<summary> 🐳 <b>Running with Docker</b> </summary>
131+
132+
To run this project in a Docker container, you'll need to pass your API keys as environment variables.
133+
134+
1. Build the Docker image
135+
```bash
136+
docker build -t pocketflow-app .
137+
```
138+
139+
2. Run the container
140+
141+
You'll need to provide your `GEMINI_API_KEY` for the LLM to function. If you're analyzing private GitHub repositories or want to avoid rate limits, also provide your `GITHUB_TOKEN`.
142+
143+
Mount a local directory to `/app/output` inside the container to access the generated tutorials on your host machine.
144+
145+
**Example for analyzing a public GitHub repository:**
146+
147+
```bash
148+
docker run -it --rm \
149+
-e GEMINI_API_KEY="YOUR_GEMINI_API_KEY_HERE" \
150+
-v "$(pwd)/output_tutorials":/app/output \
151+
pocketflow-app --repo https://github.com/username/repo
152+
```
153+
154+
**Example for analyzing a local directory:**
155+
156+
```bash
157+
docker run -it --rm \
158+
-e GEMINI_API_KEY="YOUR_GEMINI_API_KEY_HERE" \
159+
-v "/path/to/your/local_codebase":/app/code_to_analyze \
160+
-v "$(pwd)/output_tutorials":/app/output \
161+
pocketflow-app --dir /app/code_to_analyze
162+
```
163+
</details>
164+
126165
## 💡 Development Tutorial
127166
128167
- I built using [**Agentic Coding**](https://zacharyhuang.substack.com/p/agentic-coding-the-most-fun-way-to), the fastest development paradigm, where humans simply [design](docs/design.md) and agents [code](flow.py).
@@ -139,23 +178,5 @@ The application will crawl the repository, analyze the codebase structure, gener
139178
</div>
140179
<br>
141180
142-
## 🐳 Running with Docker
143-
144-
To run this project in a Docker container:
145-
146-
Make sure before building the docker image you need to setup the google api key in utils/call_llm.py.
147-
148-
### 1. Build the Docker image
149-
```bash
150-
docker build -t pocketflow-app .
151-
```
152-
153-
### 2.Run the conatainer
154-
```bash
155-
docker run -it --rm -v <path_to_output_directory>:/app/output pocketflow-app --repo <repository_link>
156-
157-
example:
158181
159-
docker run -it --rm -v C:\Users\srinadh\PocketFlow-Tutorial-Codebase-Knowledge\output:/app/output pocketflow-app --repo https://github.com/srinadhkesineni/CI-CD.git
160182
161-
```

0 commit comments

Comments
 (0)