Skip to content

Commit 8c344a7

Browse files
committed
docs: emphasize importance of cleanup script for cloned repos
Add prominent warning in installation steps about running npm run setup. This is critical for users who clone (not fork) the repo to remove GitHub Action workflows that are only needed for the main repository.
1 parent 811853a commit 8c344a7

File tree

1 file changed

+14
-6
lines changed

1 file changed

+14
-6
lines changed

README.md

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -149,39 +149,47 @@ git clone https://github.com/eyaprak/vibe-coding-starter.git
149149
cd vibe-coding-starter
150150
```
151151

152-
2. **Öncelikle template kurulum scriptini çalıştırın** (şablon dosyalarını temizler):
152+
**2. ⚠️ ÖNEMLİ: Template temizleme scriptini çalıştırın:**
153+
154+
> **MUTLAKA YAPILMASI GEREKIR!** Bu script, sadece ana repository için gerekli olan GitHub Action workflow'larını ve review script'lerini kaldırır. Eğer bu adımı atlanırsa, gereksiz dosyalar projenizde kalacaktır.
153155
154156
```bash
155157
npm run setup
156158
```
157159

158-
3. Bağımlılıkları yükleyin:
160+
**Bu script şunları kaldırır:**
161+
- `.github/workflows/claude-review.yml` - Claude AI PR review workflow (ana repo için)
162+
- `.github/workflows/template-cleanup.yml` - Otomatik temizleme workflow
163+
- `scripts/claude-pr-review.ts` - PR review script
164+
- İlgili devDependencies (`@anthropic-ai/sdk`, `@octokit/rest`)
165+
166+
**3. Bağımlılıkları yükleyin:**
159167

160168
```bash
161169
npm install
162170
```
163171

164-
4. Ortam değişkenleri dosyasını kopyalayın:
172+
**4. Ortam değişkenleri dosyasını kopyalayın:**
165173

166174
```bash
167175
cp .env.example .env
168176
```
169177

170-
5. `.env` dosyasında ortam değişkenlerinizi yapılandırın:
178+
**5. `.env` dosyasında ortam değişkenlerinizi yapılandırın:**
171179
- Veritabanı URL'i (Supabase PostgreSQL)
172180
- Supabase kimlik bilgileri
173181
- NextAuth gizli anahtarı
174182
- Stripe anahtarları
175183
- Resend API anahtarı
176184
- reCAPTCHA anahtarları
177185

178-
6. Veritabanı şemasını gönderin:
186+
**6. Veritabanı şemasını gönderin:**
179187

180188
```bash
181189
npm run db:push
182190
```
183191

184-
7. Geliştirme sunucusunu başlatın:
192+
**7. Geliştirme sunucusunu başlatın:**
185193

186194
```bash
187195
npm run dev

0 commit comments

Comments
 (0)