Unduh octopus - Unduh Kode Sumber octopus

octopus

Kode sumber lainnya

1.0.0

Unduh

Gurita

Octopus adalah halaman wiki internal tanpa server yang mudah diatur dengan dukungan diagram perangkat lunak bawaan. Ini menggunakan markdown untuk menulis konten dan meningkatkannya dengan diagram graphviz dan flowchart.js untuk dokumentasi perangkat lunak yang mudah.

Berikut halaman wiki default:

Teknologi

Octopus adalah aplikasi Jamstack yang menggunakan Google Firebase sebagai backend. Anda tidak memerlukan server web (seperti Apache) atau database (seperti MySQL) untuk menjalankan dan menjalankannya. Anda dapat menggunakan aplikasi ke CDN secara gratis menggunakan Netlify.

Dengan gurita, Anda bisa:

mengharuskan pengguna untuk masuk untuk membaca atau mengedit wiki (penyedia yang didukung: Google, github, email/kata sandi, twitter dan telepon),
Buat aturan akses untuk membaca dan mengedit (membatasi pengguna atau domain AUTH tertentu),
Host Wiki halaman di bawah domain khusus.

Fitur

Buat halaman wiki baru dengan bahasa markdown,
Edit menu (menggunakan markdown) untuk menautkan dengan mudah ke halaman wiki,
Sertakan diagram graphviz dan flowchart.js di dalam konten penurunan harga Anda,
Lihat siapa yang sedang membaca artikel wiki Anda,
Sesuaikan front-end wiki Anda dengan React (create-react-app).

Contoh Diagram Sistem

Pengeditan halaman dengan Markdown

Instalasi

Kloning repositori ini ke komputer Anda.
Salin File Template Config ( src/config/config.template.js ) ke src/config/config.js .

cp src/config/config.template.js src/config/config.js

Catatan: Anda dapat dengan aman melakukan file src/config/config.js ke repositori. File ini tidak menyimpan kredensial yang sensitif - semua variabel konfigurasi akan tersedia untuk umum di file .js .

Buat proyek Firebase baru di sini: https://firebase.google.com/
Pilih "Tambahkan Firebase ke aplikasi web Anda" dan salin konfigurasi ke src/config/config.js yang dibuat pada langkah 2.

Di Firebase Console, pergi ke Authentication > Metode Masuk , pilih penyedia dan aktifkan. Octopus telah diuji dengan penyedia Google dan GitHub.

Masih di bagian Metode Otentikasi > Masuk , tambahkan domain yang akan meng-host aplikasi Anda ke daftar domain resmi .

Bangun aplikasi:

npm install
npm run build

Menyebarkan build/ Direktori ke Server Web Anda.

Penyebaran server-less

Anda dapat melewatkan hosting aplikasi di server web Anda (Langkah 8 dari panduan instalasi di atas). Yang Anda butuhkan adalah menggunakan aplikasi ke penyedia CDN berbasis cloud.

Kami merekomendasikan menggunakan Netlify.

Ini akan secara otomatis menggunakan repo forked gurita github Anda ke produksi setelah setiap komit. Ini juga akan menyiapkan URL siap pakai yang dapat diakses oleh semua pengguna Anda segera. Nanti, Anda dapat mengatur domain khusus untuk membuatnya terlihat lebih profesional.

CATATAN: Saat menggunakan gurita melalui Netlify, isi detail berikut di Wizard Setup:

Bangun Perintah: npm run build
Direktori Publikasikan: build

Keamanan

Secara default, pengguna mana pun dapat melihat dan mengedit halaman wiki Anda. Mungkin ini bukan yang Anda harapkan!

Untuk membuat konten Anda hanya dapat diakses oleh perusahaan Anda, buka Firebase Console > Database > Aturan dan membatasi siapa yang dapat membaca dan mengedit halaman wiki Anda.

Berikut adalah aturan contoh jika Anda menggunakan penyedia masuk Google dan alamat email perusahaan Anda berakhir dengan @livechatinc.com :

{
  "rules": {
    ".read": "auth.token.email.endsWith('@livechatinc.com')",
    ".write": "auth.token.email.endsWith('@livechatinc.com')"
  }
}

Anda dapat membaca lebih lanjut tentang kemungkinan aturan keamanan dalam dokumentasi aturan database realtime.

Menggunakan gurita

Octopus dirancang agar sangat mudah digunakan.

Untuk membuat halaman baru, cukup masukkan URL yang ingin Anda buat, misalnya: https://<your-octopus-domain>/test/new-page . Jika halaman tersebut belum dibuat, Anda akan melihat layar berikut:

Saat Anda mengklik "Buat halaman ini", halaman baru akan dibuat dan diisi dengan konten default, siap untuk diedit:

Setelah halaman siap, Anda dapat dengan mudah memasukkannya ke dalam menu:

Itu saja. Kirim semua tautan rekan tim Anda ke Octopus dan mereka siap berkontribusi!

Latar Belakang Proyek

Mengapa kita membangun gurita?

Kami telah berjuang untuk menemukan perangkat lunak yang mudah digunakan untuk mendokumentasikan sistem internal di Livechat.

Kami ingin mudah berkontribusi bagi orang-orang non-teknis dan memasukkan diagram perangkat lunak yang mudah diedit . Kami tidak dapat menemukan produk yang memuaskan, jadi kami telah membangunnya.