Intlayer İçerik Yönetim Sistemi (CMS) Dokümantasyonu

Intlayer CMS, bir Intlayer projesinin içeriğini dışa aktarmanıza olanak tanıyan bir uygulamadır.

Bunun için Intlayer, 'uzak sözlükler' kavramını tanıtmaktadır.

Uzak sözlükleri anlama

Intlayer, 'yerel' ve 'uzak' sözlükler arasında ayrım yapar.

• 'Yerel' sözlük, Intlayer projenizde tanımlanmış bir sözlüktür. Örneğin bir butonun tanımlama dosyası veya navigasyon çubuğunuz gibi. İçeriğinizi dışa aktarmak bu durumda anlamlı değildir çünkü bu içeriğin sık sık değişmesi beklenmez.

• 'Uzak' sözlük ise Intlayer CMS aracılığıyla yönetilen bir sözlüktür. Ekibinizin içeriğinizi doğrudan web sitenizde yönetmesine olanak tanıyabilir ve ayrıca A/B test özelliklerini ve SEO otomatik optimizasyonunu kullanmayı hedefler.

Görsel editör ve CMS karşılaştırması

Intlayer Visual editörü, yerel sözlükler için içeriğinizi görsel bir editörde yönetmenizi sağlayan bir araçtır. Bir değişiklik yapıldığında, içerik kod tabanında değiştirilir. Bu, uygulamanın yeniden derleneceği ve yeni içeriği göstermek için sayfanın yeniden yükleneceği anlamına gelir.

Buna karşılık, Intlayer CMS, uzak sözlükler için içeriğinizi görsel bir editörde yönetmenizi sağlayan bir araçtır. Bir değişiklik yapıldığında, içerik kod tabanınızı etkilemez. Ve web sitesi otomatik olarak değiştirilen içeriği gösterir.

Entegrasyon

Paketin nasıl kurulacağına dair daha fazla detay için aşağıdaki ilgili bölüme bakınız:

Next.js ile Entegrasyon

Next.js ile entegrasyon için, kurulum kılavuzuna bakınız.

Create React App ile Entegrasyon

Create React App ile entegrasyon için, kurulum kılavuzuna bakınız.

Vite + React ile Entegrasyon

Vite + React ile entegrasyon için, kurulum kılavuzuna bakınız.

Konfigürasyon

Intlayer CMS'ye giriş yapmak için aşağıdaki komutu çalıştırın:

npx intlayer login

Bu, kimlik doğrulama işlemini tamamlamak ve Intlayer hizmetlerini kullanmak için gerekli kimlik bilgilerini (Client ID ve Client Secret) almak için varsayılan tarayıcınızı açacaktır.

Intlayer konfigürasyon dosyanızda, CMS ayarlarını özelleştirebilirsiniz:

import type { IntlayerConfig } from "intlayer";

const config: IntlayerConfig = {
  // ... diğer konfigürasyon ayarları
  editor: {
    /**
     * Gerekli
     *
     * Uygulamanın URL'si.
     * Bu, görsel editörün hedeflediği URL'dir.
     */
    applicationURL: process.env.INTLAYER_APPLICATION_URL,

    /**
     * Gerekli
     *
     * Editörü etkinleştirmek için Client ID ve client secret gereklidir.
     * Bunlar, içeriği düzenleyen kullanıcıyı tanımlamaya olanak sağlar.
     * Intlayer Dashboard - Projects (https://app.intlayer.org/projects) üzerinden yeni bir client oluşturarak elde edilebilir.
     * clientId: process.env.INTLAYER_CLIENT_ID,
     * clientSecret: process.env.INTLAYER_CLIENT_SECRET,
     */
    clientId: process.env.INTLAYER_CLIENT_ID,
    clientSecret: process.env.INTLAYER_CLIENT_SECRET,

    /**
     * Opsiyonel
     *
     * Intlayer CMS'yi kendi sunucunuzda barındırıyorsanız, CMS'nin URL'sini ayarlayabilirsiniz.
     *
     * Intlayer CMS'nin URL'si.
     * Varsayılan olarak https://intlayer.org olarak ayarlanmıştır.
     */
    cmsURL: process.env.INTLAYER_CMS_URL,

    /**
     * Opsiyonel
     *
     * Intlayer CMS'yi kendi sunucunuzda barındırıyorsanız, backend'in URL'sini ayarlayabilirsiniz.
     *
     * Intlayer CMS'nin URL'si.
     * Varsayılan olarak https://back.intlayer.org olarak ayarlanmıştır.
     */
    backendURL: process.env.INTLAYER_BACKEND_URL,
  },
};

export default config;

Eğer bir client ID ve client secret'ınız yoksa, bunları Intlayer Dashboard - Projects üzerinden yeni bir client oluşturarak edinebilirsiniz.

Mevcut tüm parametreleri görmek için konfigürasyon dokümantasyonuna bakınız.

CMS Kullanımı

Konfigürasyonunuzu Gönderme

Intlayer CMS'yi yapılandırmak için intlayer CLI komutlarını kullanabilirsiniz.

npx intlayer config push

intlayer.config.ts yapılandırma dosyanızda ortam değişkenleri kullanıyorsanız, istediğiniz ortamı --env argümanıyla belirtebilirsiniz:

npx intlayer config push --env production

Bu komut yapılandırmanızı Intlayer CMS'ye yükler.

Bir sözlük yükleme

Yerel sözlüklerinizi uzak bir sözlüğe dönüştürmek için intlayer CLI komutlarını kullanabilirsiniz.

npx intlayer dictionary push -d my-first-dictionary-key

intlayer.config.ts yapılandırma dosyanızda ortam değişkenleri kullanıyorsanız, istediğiniz ortamı --env argümanıyla belirtebilirsiniz:

npx intlayer dictionary push -d my-first-dictionary-key --env production

Bu komut, başlangıç içerik sözlüklerinizi yükler ve Intlayer platformu üzerinden eşzamansız olarak alınmalarını ve düzenlenmelerini sağlar.

Sözlüğü düzenleme

Daha sonra sözlüğünüzü Intlayer CMS üzerinde görüntüleyip yönetebileceksiniz.

Canlı senkronizasyon

Canlı Senkronizasyon, uygulamanızın CMS içerik değişikliklerini çalışma zamanında yansıtmasını sağlar. Yeniden derleme veya yeniden dağıtım gerekmez. Etkinleştirildiğinde, güncellemeler uygulamanızın okuduğu sözlükleri yenileyen bir Canlı Senkronizasyon sunucusuna aktarılır.

Canlı Senkronizasyon sürekli bir sunucu bağlantısı gerektirir ve yalnızca enterprise planında kullanılabilir.

Intlayer yapılandırmanızı güncelleyerek Canlı Senkronizasyonu etkinleştirin:

import type { IntlayerConfig } from "intlayer";

const config: IntlayerConfig = {
  // ... diğer yapılandırma ayarları
  editor: {
    /**
     * Değişiklik algılandığında yerel ayar yapılandırmalarının sıcak yeniden yüklemesini etkinleştirir.
     * Örneğin, bir sözlük eklendiğinde veya güncellendiğinde, uygulama sayfada görüntülenen içeriği günceller.
     *
     * Sıcak yeniden yükleme sürekli bir sunucu bağlantısı gerektirdiği için,
     * yalnızca `enterprise` planı müşterileri için kullanılabilir.
     *
     * Varsayılan: false
     */
    liveSync: true,
  },
  dictionary: {
    /**
     * Sözlüklerin nasıl içe aktarılacağını kontrol eder:
     *
     * - "live": Sözlükler, Live Sync API kullanılarak dinamik olarak getirilir.
     *   useIntlayer yerine useDictionaryDynamic kullanılır.
     *
     * Not: Canlı mod, sözlükleri getirmek için Live Sync API'sini kullanır. API çağrısı
     * başarısız olursa, sözlükler dinamik olarak içe aktarılır.
     * Not: Yalnızca uzak içeriğe ve "live" bayraklarına sahip sözlükler canlı modu kullanır.
     * Diğerleri performans için dinamik modu kullanır.
     */
    importMode: "fetch",
  },
};

export default config;

Uygulamanızı sarmak için Live Sync sunucusunu başlatın:

Next.js kullanarak örnek:

{  "scripts": {    // ... diğer komutlar    "build": "next build",    "dev": "next dev",    "start": "npx intlayer live --with 'next start'",  },}

Vite kullanarak örnek:

{  "scripts": {    // ... diğer komutlar    "build": "vite build",    "dev": "vite dev",    "start": "npx intlayer live --with 'vite start'",  },}

Live Sync sunucusu uygulamanızı sarar ve güncellenen içeriği geldiği anda otomatik olarak uygular.

CMS'den değişiklik bildirimleri almak için, Live Sync sunucusu backend ile bir SSE bağlantısı sürdürür. CMS'de içerik değiştiğinde, backend güncellemeyi Live Sync sunucusuna iletir ve bu sunucu yeni sözlükleri yazar. Uygulamanız, sonraki gezinme veya tarayıcı yenilemesinde güncellemeyi yansıtacaktır, yeniden derleme gerekmez.

Akış şeması (CMS/Backend -> Live Sync Sunucusu -> Uygulama Sunucusu -> Ön Yüz):

Nasıl çalışır:

Geliştirme iş akışı (yerel)

• Geliştirme aşamasında, uygulama başladığında tüm uzak sözlükler alınır, böylece güncellemeleri hızlıca test edebilirsiniz.
• Next.js ile Live Sync'i yerel olarak test etmek için geliştirme sunucunuzu şu şekilde sarmalayın:

{  "scripts": {    // ... diğer scriptler    "dev": "npx intlayer live --with 'next dev'",    // "dev": "npx intlayer live --with 'vite dev'", // Vite için  },}

Optimizasyonu etkinleştirin, böylece Intlayer geliştirme sırasında Live import dönüşümlerini uygular:

import type { IntlayerConfig } from "intlayer";

const config: IntlayerConfig = {
  editor: {
    applicationURL: "http://localhost:5173",
    liveSyncURL: "http://localhost:4000",
    liveSync: true,
  },
  dictionary: {
    importMode: "fetch",
  },
  build: {
    optimize: true,
  },
};

export default config;

Bu yapılandırma, geliştirme sunucunuzu Live Sync sunucusuyla sarar, başlangıçta uzak sözlükleri getirir ve CMS'den SSE aracılığıyla güncellemeleri aktarır. Değişiklikleri görmek için sayfayı yenileyin.

Notlar ve kısıtlamalar:

• Live sync kaynağını site güvenlik politikanıza (CSP) ekleyin. Live sync URL'sinin connect-src içinde (ve ilgili ise frame-ancestors içinde) izinli olduğundan emin olun.
• Live Sync statik çıktı ile çalışmaz. Next.js için, sayfa çalışma zamanında güncellemeleri alabilmek için dinamik olmalıdır (örneğin, tam statik kısıtlamalardan kaçınmak için generateStaticParams, generateMetadata, getServerSideProps veya getStaticProps uygun şekilde kullanılmalıdır).
• CMS'de, her sözlüğün bir live bayrağı vardır. Yalnızca live=true olan sözlükler live sync API'si aracılığıyla alınır; diğerleri dinamik olarak içe aktarılır ve çalışma zamanında değişmeden kalır.
• live bayrağı her sözlük için derleme zamanında değerlendirilir. Uzaktaki içerik derleme sırasında live=true olarak işaretlenmemişse, o sözlük için Live Sync'i etkinleştirmek üzere yeniden derleme yapmanız gerekir.
• Live sync sunucusunun .intlayer dosyasına yazabilmesi gerekir. Konteynerlerde, /.intlayer dosyasına yazma erişiminin olduğundan emin olun.

Hata Ayıklama

CMS ile ilgili herhangi bir sorunla karşılaşırsanız, aşağıdakileri kontrol edin:

• Uygulamanın çalıştığından emin olun.

• editor yapılandırmasının Intlayer yapılandırma dosyanızda doğru şekilde ayarlandığından emin olun.
  • Gerekli alanlar:
• Uygulama URL'si, editör yapılandırmasında (applicationURL) belirttiğinizle eşleşmelidir.

• CMS URL'si

• Proje yapılandırmasının Intlayer CMS'ye gönderildiğinden emin olun.

• Görsel editör, web sitenizi görüntülemek için bir iframe kullanır. Web sitenizin İçerik Güvenlik Politikası'nın (CSP), CMS URL'sine frame-ancestors olarak izin verdiğinden emin olun (varsayılan olarak 'https://intlayer.org'). Herhangi bir hata için editör konsolunu kontrol edin.