@carbonconsulting/fe-boilerplate
v1.0.4
Published
Carbon Consulting Frontend Projects Boilerplate
Downloads
12
Readme
@carbonconsulting/fe-boilerplate
Carbon Consulting Frontend Boilerplate, modern web uygulamaları geliştirmek için hızlı, güvenilir ve ölçeklenebilir bir başlangıç noktası sunar. Bu boilerplate, TypeScript tabanlı bir Next.js projesi olup, Carbon Consulting'in frontend projelerinde tutarlılık ve üretkenlik sağlamak amacıyla tasarlanmıştır. Tailwind CSS, Redux Toolkit, NextAuth, Axios, React Toastify gibi popüler araçlarla donatılmıştır.
Özellikler
- Next.js 15: App Router ve Turbopack destekli modern React framework'ü.
- TypeScript: Tür güvenliği ve geliştirici dostu kodlama deneyimi.
- Tailwind CSS: Hızlı ve özelleştirilebilir stil oluşturma.
- Redux Toolkit: Durum yönetimi için güçlü ve basit bir çözüm.
- NextAuth: Google ile oturum açma gibi kimlik doğrulama özellikleri.
- Axios: Kolay ve tekrar kullanılabilir API istekleri.
- React Toastify: Kullanıcı dostu bildirimler.
- ESLint: Kod kalitesini korumak için yapılandırılmış linting.
Kurulum
Bu boilerplate'i projenize entegre etmek için aşağıdaki adımları takip edin.
1. Yeni Bir Proje Oluşturun
Yeni bir dizin oluşturun ve bir Node.js projesi başlatın:
mkdir my-project
cd my-project
npm init -y2. Boilerplate'i Yükleyin
NPM üzerinden boilerplate'i yükleyin:
npm install @carbonconsulting/fe-boilerplate3. Dosyaları Kopyalayın
Boilerplate dosyalarını projenize kopyalayın:
cp -r node_modules/@carbonconsulting/fe-boilerplate/* .
cp -r node_modules/@carbonconsulting/fe-boilerplate/.* .4. Ortam Değişkenlerini Yapılandırın
.env.local.example dosyasını .env.local olarak kopyalayın ve gerekli ortam değişkenlerini doldurun:
cp .env.local.example .env.local.env.local dosyasını açın ve aşağıdaki değişkenleri güncelleyin:
NEXT_PUBLIC_BASE_URL=http://localhost:3000
#When deploying your site set the NEXTAUTH_URL environment variable to the canonical URL of the website.
#NEXTAUTH_URL=localhost:3000/api/auth/callback/google5. Bağımlılıkları Yükleyin
Proje bağımlılıklarını yükleyin:
npm install6. Geliştirme Sunucusunu Başlatın
Geliştirme sunucusunu başlatın:
npm run devTarayıcıda http://localhost:3000 adresine gidin ve boilerplate'in çalıştığını doğrulayın.
7. Özelleştirme
- Sayfalar: Yeni sayfalar eklemek için
src/appdizinine yeni dosya veya klasörler ekleyin. - Redux: Yeni reducer'lar ve slice'lar için
src/store/featuresdizinini kullanın. - API İstekleri:
src/lib/axios.tsüzerinden API isteklerini yapılandırın. - Stiller: Tailwind CSS kullanarak bileşenlerinizi özelleştirin.
Lisans
Bu proje MIT Lisansı altında lisanslanmıştır.
İletişim
Sorularınız veya destek talepleriniz için Carbon Consulting ile iletişime geçebilirsiniz.
