readme.md 5.47 KB
Newer Older
Emincan Özcan's avatar
Emincan Özcan committed
1
# Pardus Kataliz
Emincan Özcan's avatar
Emincan Özcan committed
2

3
Pardus Kataliz, Pardus'a geçiş planlayan ya da yeni geçmiş kullanıcılar düşünülerek tasarlanmış bir uygulama mağazasıdır. Kullanıcılara masaüstü uygulaması ve web sitesi olarak hizmet sunar. 
Emincan Özcan's avatar
Emincan Özcan committed
4

Emincan Özcan's avatar
Emincan Özcan committed
5
Pardus kullanan kullanıcılar Kataliz Pardus uygulaması ile en iyi deneyimi elde ederken, Pardus'u henüz kurmamış kullanıcılar Kataliz web sürümü üzerinden pek çok özelliğe erişim sağlayabilmekte ve Pardus'a geçiş yapmak için ön hazırlık gerçekleştirebilmektedir. 
Emincan Özcan's avatar
Emincan Özcan committed
6

7
Proje, Türkiye Açık Kaynak Platformu tarafından gerçekleştirilen Açık Kaynak Hackathon Programı kapsamında hayata geçirilmiştir.
Emincan Özcan's avatar
Emincan Özcan committed
8

9
Uygulamanın amaç ve kullanımına dair hazırlanan videoyu [Youtube üzerinden izlemek için tıklayınız.](https://www.youtube.com/watch?v=FICAoZfK9Po)
Emincan Özcan's avatar
Emincan Özcan committed
10 11 12 13 14 15 16 17
# Doküman İçerik Tablosu 

- [Projeye Neden Kataliz İsmi Verildi?](#projeye-neden-kataliz-i̇smi-verildi)
- [Yazılım Detayları / Geliştirme](#yazılım-detayları--geliştirme)
  - [Arka Uç](#arka-uç)
  - [Pardus ve Web Uygulaması](#pardus-ve-web-uygulaması)
- [Katalizi Nasıl - Nereden Test Edebilirim?](#katalizi-nasıl---nereden-test-edebilirim)
- [Lisans](#lisans)
Emincan Özcan's avatar
Emincan Özcan committed
18

19
# Projeye Neden Kataliz İsmi Verildi?
Emincan Özcan's avatar
Emincan Özcan committed
20

21 22 23 24 25 26 27
Kataliz; katalizör adı verilen kimyasalların, bir kimyasal tepkime için ihtiyaç duyulan enerjiyi düşürmesi ve tepkime sürecini ciddi anlamda hızlandırması işlemine denir.

Geliştirilen uygulama mağazasının hedefi; kullanıcıların Pardus uygulama arayış ve kurulum süreçlerine harcayacakları enerjiyi ve vakti azaltmak olduğundan, Kataliz ismi tercih edilmiştir.

# Yazılım Detayları / Geliştirme

Pardus Kataliz projesi; bir adet Pardus uygulaması, bir adet web uygulaması ve bu 2 istemcinin veri kaynağı olarak kullandığı - yönetici paneli de barındıran bir arka uç uygulamasından bir oluşur.
Emincan Özcan's avatar
Emincan Özcan committed
28

Emincan Özcan's avatar
Emincan Özcan committed
29
Uygulamanın Pardus ve web versiyonları birlikte geliştirilmekte, aynı kod tabanını paylaşmaktadır.
Emincan Özcan's avatar
Emincan Özcan committed
30

31
## Arka Uç
Emincan Özcan's avatar
Emincan Özcan committed
32

Emincan Özcan's avatar
Emincan Özcan committed
33
Uygulamanın veri kaynağı olarak kullanılan bir API ve yönetim paneli sağlar. Laravel / Jetstream altyapısıyla hayata geçirilmiştir. Proje dizininde yer alan backend klasörü üzerinden erişilebilir.
Emincan Özcan's avatar
Emincan Özcan committed
34

35
**Yönetim Panelinde Bulunan Temel Özellikler;**
Emincan Özcan's avatar
Emincan Özcan committed
36
* Pardus uygulaması ekleyebilme ve yönetebilme
Emincan Özcan's avatar
Emincan Özcan committed
37 38 39
  * Uygulama adı
  * Uygulama görseli
  * Uygulama kurulum betikleri
Emincan Özcan's avatar
Emincan Özcan committed
40
* Pardus harici uygulama ekleyebilme ve yönetebilme
Emincan Özcan's avatar
Emincan Özcan committed
41 42
  * Uygulama adı
  * Uygulama görseli
Emincan Özcan's avatar
Emincan Özcan committed
43 44
  * Uygulamanın Pardus ekosistemindeki alternatifleri
* Uygulama paketi ekleyebilme ve yönetebilme
Emincan Özcan's avatar
Emincan Özcan committed
45 46
  * Paket adı
  * Paket görseli
Emincan Özcan's avatar
Emincan Özcan committed
47
  * Pardus uygulamaları 
Emincan Özcan's avatar
Emincan Özcan committed
48

Emincan Özcan's avatar
Emincan Özcan committed
49
Arka uç için geliştirme ortamı olarak Laravel Sail altyapısından faydalanılmaktadır. Farklı ortamlar üzerinde de geliştirmeye devam edilebilir ancak Laravel Sail kullanımı önerilmektedir. Laravel Sail kullanımına dair detaylar [laravel.com/docs/8.x/sail](https://laravel.com/docs/8.x/sail) adresinden incelenebilir.
Emincan Özcan's avatar
Emincan Özcan committed
50

51
## Pardus ve Web Uygulaması
Emincan Özcan's avatar
Emincan Özcan committed
52

53
Kataliz'in Pardus uygulaması Electron - Vue altyapısıyla hazırlanmaktadır. Pardus uygulaması ve Web uygulaması tek bir kod tabanı üzerinde geliştirilmektedir. Pardus uygulaması, Web uygulamasına ek olarak uygulama içerisinden kurulum desteği de sağlamaktadır. Pardus sürümünde yer alan bir takım özelliklerin devre dışı bırakılması veya Web'e uyarlanmasıyla Web sürümü ortaya çıkmaktadır.
Emincan Özcan's avatar
Emincan Özcan committed
54

Emincan Özcan's avatar
Emincan Özcan committed
55
İlgili uygulama(lar) proje içerisinde client klasöründe konumlandırılmıştır. 
Emincan Özcan's avatar
Emincan Özcan committed
56

Emincan Özcan's avatar
Emincan Özcan committed
57
Uygulamaları geliştirme ortamında çalıştırabilmek ya da paketleyebilmek için;
Emincan Özcan's avatar
Emincan Özcan committed
58
  * İlk olarak `npm install` ya da `yarn` komutlarıyla bağımlılıklar indirilmeli,
Emincan Özcan's avatar
Emincan Özcan committed
59 60 61 62 63 64 65 66
  * Geliştirme ortamını ayağa kaldırmak için;
    * Masaüstü versiyonu için `yarn electron:serve` komutu
    * Web versiyonu için `yarn serve` komutu
  * Uygulamayı paketlemek için;
    * Masaüstü versiyonu için `yarn electron:build` komutu
    * Web versiyonu için `yarn build` komutu
kullanılabilmektedir.

Emincan Özcan's avatar
Emincan Özcan committed
67 68 69
Masaüstü uygulaması için paketleme işlemi yapıldığında, appimage ve deb şeklinde iki farklı dosya formatıyla uygulama paketlenmekte ve kullanıcıya sunulmaktadır. 
* **Deb formatlı çıktı:** Pardus Paket Kurucu programıyla ya da alternatif metotlarla kurulum sağlamak için kullanılabilmektedir.
* **Appimage formatlı çıktı:** kurulum olmaksızın programı çalıştırmak için kullanılabilmektedir.
Emincan Özcan's avatar
Emincan Özcan committed
70

71
# Katalizi Nasıl - Nereden Test Edebilirim?
Emincan Özcan's avatar
Emincan Özcan committed
72

Emincan Özcan's avatar
Emincan Özcan committed
73 74 75
Uygulamayı bu depo üzerinden klonlayarak, üst bölümde anlatılan adımlar aracılığıyla bilgisayarınızda çalıştırabilir, tüm özellikleri test edebilirsiniz.

Geliştirilen uygulamaya doğrudan erişim sağlamak için;
Emincan Özcan's avatar
Emincan Özcan committed
76

Emincan Özcan's avatar
Emincan Özcan committed
77
* Masaüstü uygulaması; Uygulama Github actions ile paketlenmekte ve Github üzerinden çeşitli versiyonlarla birlikte indirilmeye sunulmaktadır. https://github.com/emincanozcan/kataliz/releases adresinden uygulama temin edilebilir, son sürüm önerilir.
Emincan Özcan's avatar
Emincan Özcan committed
78
* Web uygulaması; [kataliz.emincanozcan.com](https://kataliz.emincanozcan.com) adresi üzerinden yayınlanmaktadır, bu adres üzerinden incelenebilir.
79 80 81 82 83
* Arka uç ve yönetici paneli; [kataliz-admin.emincanozcan.com](https://kataliz-admin.emincanozcan.com) adresi üzerinden yayınlanmaktadır. İlgili yönetim paneline yetkisiz erişim, bu arka uca bağlanan uygulamalarda istenmeyen etkiler yaratabileceğinden yönetici bilgileri paylaşılmamaktadır. Yönetici erişimi için `emincanozcann@gmail.com` üzerinden iletişime geçilebilir.

# Lisans

Kataliz mağaza servisi, GPL 3 lisansı ile sunulmaktadır.