mirror of
https://github.com/kemalersin/fonparam-backend.git
synced 2026-04-26 17:55:54 +03:00
No description
| src | ||
| .env.example | ||
| .eslintrc | ||
| .gitignore | ||
| .nvmrc | ||
| LICENSE | ||
| package-lock.json | ||
| package.json | ||
| README.md | ||
| tsconfig.json | ||
📊 FonParam API
FonParam, Türkiye'deki yatırım fonlarının verilerini sunan bir API servisidir.
✨ Özellikler
- 📈 Yatırım fonlarının güncel ve geçmiş verilerini sorgulama
- 🏢 Portföy yönetim şirketleri hakkında detaylı bilgiler
- 🔄 Fonların karşılaştırmalı analizi
- 📊 Performans istatistikleri ve getiri oranları
🚦 Rate Limiting
API'nin tüm endpointleri için rate limiting uygulanmaktadır:
- ⏱️ Her endpoint için 15 dakikada maksimum 25 istek
- 📅 Her endpoint için günlük maksimum 100 istek
- ⚠️ Rate limit aşıldığında 429 (Too Many Requests) hatası döner
- 🔒 Rate limit sayaçları IP bazlı tutulur
🚀 Kurulum
- Repoyu klonlayın:
git clone git@github.com:kemalersin/fonparam-backend.git
cd fonparam-backend
- Bağımlılıkları yükleyin:
npm install
- Örnek env dosyasını kopyalayıp düzenleyin:
cp .env.example .env
- Veritabanını oluşturun:
CREATE DATABASE fonparam CHARACTER SET utf8mb4 COLLATE utf8mb4_turkish_ci;
- Uygulamayı başlatın:
# 🔧 Geliştirme modu
npm run dev
# 🚀 Prodüksiyon modu
npm run build
npm start
📚 API Dokümantasyonu
API dokümantasyonuna http://localhost:3000/api-docs adresinden erişebilirsiniz.
🛠️ Teknolojiler
- ⚡ Node.js & Express.js
- 🎯 TypeScript
- 🗄️ MySQL & Sequelize ORM
- 📝 Swagger API Dokümantasyonu
- 🔒 JWT Tabanlı Güvenlik
- 🚦 Rate Limiting & Caching
🤝 Katkıda Bulunma
- Fork'layın
- Feature branch oluşturun (
git checkout -b feature/amazing-feature) - Değişikliklerinizi commit edin (
git commit -m 'feat: amazing new feature') - Branch'inizi push edin (
git push origin feature/amazing-feature) - Pull Request oluşturun
📜 Lisans
Bu proje MIT lisansı altında lisanslanmıştır. Detaylar için LICENSE dosyasına bakınız.