Bu kod tabanında, şu anda yapım aşamasında bulunan açık-kaynak.org'nun önizleme sürümü yer almaktadır.
master
branch'ine aktarılan değişiklikler, bir dizi derleme işleminden sonra https://acik-kaynak.org/
adresinde belirecektir.
node.js
'in ve yarn
'ın sisteminizde kurulu olduğundan emin olun.
Repository'i klonlayıp, npm üzerinden bağımlılıkları çekerek çalışma ortamınızı hazır hale getirin.
git clone https://github.com/acikkaynak/acikkaynak-website.git
cd acikkaynak-website
yarn install
yarn dev
yarn dev
komutu ile geliştirme modunda kod tabanına müdahale etmeye başlayabilirsiniz. Komutu çalıştırdıktan bir süre
sonra browser'ınız açılacak, siz değişiklik yaptığınız sürece "hot reloading" sayesinde browser'daki kod otomatik olarak
güncellenecektir.
yarn lint
komutu ile yazılan kodun belirlenen eslint standartlarına uyup uymadığını kontrol edebilirsiniz. Eğer bu
kontrolü yapmazsanız Pull Request oluşturduğunuzda GitHub tarafından bu kontroller otomatik işletilecek ve açmış olduğunuz
Pull Request'i sizden güncellemenizi isteyecektir.
Bazı kod standartları otomatik olarak düzeltilebilmektedir, bunu sağlamak için yarn lint:fix
komutunu kullanabilirsiniz.
Aynı zamanda yazmış olduğunuz birim testlerini yarn test
komutu ile başlatabilirsiniz. Testler de aynı lint işlemi gibi
hem pull request hem de push esnasında GitHub Actions tarafından CI/CD otomasyonuna bağlı olarak çalıştırılmaktadır.
Klasör | Açıklama |
---|---|
/src/ |
Kaynak dosyalarını içeren klasör |
/src/app/ |
Ana uygulama kaynak kodları |
/src/app/layouts/default/ |
- Varsayılan tema |
/src/app/layouts/default/assets/ |
- Varsayılan temanın assetleri (resim, font, stiller, v.b.) |
/src/app/layouts/shared/assets/ |
- Tüm temaların ortak assetleri (resim, font, stiller, v.b.) |
/src/app/pages/ |
- Sayfalar ve sayfalara ait React bileşenleri |
/src/app/app.tsx |
- Uygulamanın router noktası |
/src/startup.ts |
Tüm uygulama için bağımlılık bağlantıları ve konfigurasyon |
/src/index.html |
HTML Şablonu |
/semantic-ui/ |
Semantic UI'a ait tema ve site özelleştirme yapısı |
/public/ |
Web dizininde yer alacak tüm statik dosyalar |
GitHub Projesi üzerinde detaylar yer almaktadır.
- node.js (https://nodejs.org/)
Webfontları içeri gömmek için google-webfonts-helper kullanılmaktadır.
Apache 2.0, daha fazla detay için lütfen LICENSE dosyasını inceleyin.
contributors.md dosyasını inceleyebilirsiniz.
Herhangi bir katkıya açıktır. Hata düzenlemeleri, yeni özellik ve modüller ekleyebilirsiniz.
- Koda katkı sağlamak için: Yukarıda anlatıldığı gibi repository'i klonlayın, değişikliklerinizi gerçekleştirin, ve bir pull request oluşturun.
- Bir hata bildirmek için: Bir şeyler ters gidiyorsa, GitHub Issues üzerinden yeni bir issue oluşturup bize bildirin.