pages cms

Halaman CMS

Halaman CMS adalah sistem manajemen konten sumber terbuka untuk GitHub. Ini sangat cocok untuk generator situs statis (misalnya Jekyll, Next.js, Vuepress, Hugo).

Ini menawarkan antarmuka yang ramah pengguna untuk mengedit konten situs web atau aplikasi Anda secara langsung di GitHub.

Tonton demo ▶

Dokumentasi

Pergi ke pagescms.org/docs.

Dibangun dengan

• Next.js
• Tailwind CSS
• shadcn/ui
• gerimis
• Vercel
• Turso
• Ulang

Gunakan online

Cara termudah untuk memulai adalah dengan menggunakan versi online CMS. Anda akan dapat masuk dengan akun GitHub Anda dan mendapatkan versi terbaru dari CMS halaman.

Versi online ini identik dengan apa yang ada di repo ini, tetapi Anda juga dapat menginstal versi Anda sendiri secara lokal atau menggunakannya (gratis) di Vercel mengikuti langkah -langkah di bawah ini.

Instal dan Deploy

Buat Aplikasi GitHub

Apakah Anda menginstal halaman CMS secara lokal atau menggunakannya secara online, Anda akan memerlukan aplikasi GitHub.

Anda dapat membuatnya di bawah akun pribadi Anda (https://github.com/settings/apps) atau di bawah salah satu organisasi Anda (https://github.com/organizations//settings/apps).

Anda perlu mengisi informasi berikut:

• Nama Aplikasi GitHub : Gunakan "Halaman CMS" atau apa pun yang menurut Anda sesuai (misalnya "halaman CMS (dev)").
• URL Beranda : Apa pun yang Anda inginkan, https://pagescms.org akan melakukannya.
• Mengidentifikasi dan mengesahkan pengguna :
  • URL Callback: URL untuk /api/auth/github :
    • http://localhost:3000/api/auth/github untuk pengembangan,
    • Sesuatu seperti https://my-vercel-url.vercel.app/api/auth/github (atau domain khusus apa pun yang Anda gunakan) jika Anda menggunakan Vercel.
  • Token otorisasi pengguna yang kedaluwarsa: no.
  • Minta otorisasi pengguna (oAuth) selama instalasi: ya.
  • Aktifkan Aliran Perangkat: Tidak.
• Posting Instalasi :
  • Pengaturan URL (Opsional): Biarkan kosong.
  • Redirect on Update: Tidak.
• Webhook :
  • Aktif: Ya.
  • URL Webhook: URL (publik) untuk /api/webhook/github :
    • Untuk pengembangan, Anda harus menggunakan sesuatu seperti Ngrok. Anda akan berakhir dengan sesuatu seperti https://your-unique-subdomain.ngrok-free.app/api/webhook/github .
    • Sesuatu seperti https://my-vercel-url.vercel.app/api/webhook/github (atau domain khusus apa pun yang Anda gunakan) jika Anda menggunakan Vercel.
  • Rahasia: Hasilkan string acak (misalnya dengan openssl rand -base64 32 pada macOS/linux)
• Izin :
  • Izin Repositori:
    • Administrasi: Baca & Tulis
    • Isi: Baca & Tulis
    • Metadata: Baca saja
  • Izin Organisasi: Tidak Ada.
  • Izin Akun: Tidak Ada.
• Berlangganan acara :
  • Target Instalasi
  • Repositori (Anda mungkin perlu menambahkan ini setelah membuat aplikasi GitHub)
• Di mana aplikasi github ini dapat diinstal? : Anda ingin memilih "akun apa pun" kecuali Anda berniat hanya menggunakan halaman CMS di akun aplikasi github ini dibuat di bawah.

Variabel Lingkungan

Variabel	Komentar
CRYPTO_KEY	Digunakan untuk mengenkripsi/mendekripsi token github dalam database. Pada MacOS/Linux*, Anda dapat menggunakan openssl rand -base64 32 .
GITHUB_APP_ID	ID Aplikasi GitHub dari halaman Detail Aplikasi GitHub Anda.
GITHUB_APP_NAME	Nama mesin untuk aplikasi GitHub Anda (mis. pages-cms ), harus menjadi slug URL dari halaman Detail Aplikasi GitHub Anda.
GITHUB_APP_PRIVATE_KEY	File PEM Anda dapat mengunduh pembuatan aplikasi GitHub.
GITHUB_APP_WEBHOOK_SECRET	Rahasia yang Anda pilih untuk Webhook Anda. Ini digunakan untuk memastikan permintaan datang dari GitHub.
GITHUB_APP_CLIENT_ID	ID Klien Aplikasi GitHub dari halaman Detail Aplikasi GitHub Anda.
GITHUB_APP_CLIENT_SECRET	GITHUB APP CLIENT Secret yang Anda hasilkan di halaman Detail Aplikasi TheGithub.
RESEND_API_KEY	Anda akan mendapatkannya saat Anda membuat akun ulang (gratis) untuk menangani email.
SQLITE_URL	file:./local.db untuk pengembangan, libsql://pages-cms-username.turso.io misalnya jika Anda menggunakan Turso (Anda harus, Turso hebat).
SQLITE_AUTH_TOKEN	Biarkan kosong untuk pengembangan, jika tidak gunakan token yang disediakan oleh Turso (jika itu yang Anda gunakan).
BASE_URL	OPSIONAL . Jika Anda menggunakan Vercel atau bekerja secara lokal, Anda tidak akan membutuhkannya. Jika Anda menggunakan di tempat lain, Anda harus menentukan URL dasar untuk aplikasi (misalnya https://mycustomdomain.com ).

Pengembangan Lokal

Kami menganggap Anda sudah membuat aplikasi GitHub dan memiliki terowongan yang sedang berjalan untuk aplikasi GitHub Webhook (menggunakan NGROK misalnya):

1. Instal Ketergantungan : npm install
2. Perbarui Variabel Lingkungan Anda : Salin .env.example ke .env dan isi nilai sesuai dengan pengaturan Anda (lihat bagian di atas).
3. Buat database : npm run db:migrate
4. Jalankan : npm run dev

Menyebarkan di Vercel

1. Buat database SQLite : Saya sarankan menggunakan Turso, karena gratis (dan cukup mengagumkan)

2. Deploy to Vercel : Pada tahap ini Anda memiliki 2 pilihan:

   1. Buat garpu : garpu pages-cms/pages-cms repo di akun Anda dan sebarkan garpu itu. Ini akan memungkinkan Anda untuk mendapatkan pembaruan. Pastikan Anda mendefinisikan semua variabel lingkungan yang tercantum di atas .

   2. Gunakan tombol Deploy :

3. Perbarui Aplikasi Github OAuth Anda : Anda mungkin harus kembali ke pengaturan aplikasi GitHub Anda untuk memperbarui beberapa pengaturan setelah Anda memiliki URL Vercel (misalnya "URL Callback" dan "Webhook URL").

Tuan rumah diri sendiri

Ada banyak pilihan lain: fly.io, digital samudera, render, sst, dll.

Lisensi

Segala sesuatu dalam repo ini dirilis di bawah lisensi MIT.