outline

Basis pengetahuan yang cepat dan kolaboratif untuk tim Anda yang dibangun menggunakan React dan Node.js.
Cobalah Outline menggunakan versi yang kami host di www.getoutline.com.

Ini adalah kode sumber yang menjalankan Outline dan semua layanan terkait. Jika Anda ingin menggunakan Outline maka Anda tidak perlu menjalankan kode ini, kami menawarkan versi aplikasi yang dihosting di getoutline.com. Anda juga dapat menemukan dokumentasi tentang penggunaan Outline di panduan kami.

Jika Anda ingin menjalankan salinan Outline Anda sendiri atau berkontribusi pada pengembangan, inilah tempat yang tepat untuk Anda.

Instalasi

Silakan lihat dokumentasi untuk menjalankan salinan Outline Anda sendiri dalam konfigurasi produksi.

Jika Anda memiliki pertanyaan atau perbaikan pada dokumen, silakan buat rangkaian pesan di diskusi GitHub.

Perkembangan

Terdapat panduan singkat untuk menyiapkan lingkungan pengembangan jika Anda ingin berkontribusi pada perubahan, perbaikan, dan penyempurnaan pada Outline.

Berkontribusi

Outline dibuat dan dikelola oleh tim kecil – kami membutuhkan bantuan Anda untuk memperbaiki bug dan menambahkan fitur!

Sebelum mengirimkan pull request, silakan berdiskusi dengan tim inti dengan membuat atau mengomentari masalah di GitHub – kami juga ingin mendengar pendapat Anda dalam diskusi. Dengan cara ini kita dapat memastikan bahwa suatu pendekatan disepakati sebelum kode ditulis. Ini akan menghasilkan kemungkinan lebih tinggi untuk menerima kode Anda.

Jika Anda mencari cara untuk memulai, berikut daftar cara untuk membantu kami menyempurnakan Outline:

• Terjemahan ke bahasa lain
• Masalah dengan label good first issue
• Peningkatan kinerja, baik di server maupun frontend
• Kebahagiaan dan dokumentasi pengembang
• Bug dan masalah lain yang terdaftar di GitHub

Arsitektur

Jika Anda tertarik untuk berkontribusi atau mempelajari lebih lanjut tentang basis kode Outline, silakan merujuk ke dokumen arsitektur terlebih dahulu untuk mendapatkan ikhtisar tingkat tinggi tentang cara aplikasi disatukan.

Men-debug

Dalam pengembangan, Outline menghasilkan logging sederhana ke konsol, diawali berdasarkan kategori. Dalam produksi, ini menghasilkan log JSON, ini dapat dengan mudah diuraikan oleh saluran penyerapan log pilihan Anda.

Pencatatan log HTTP dinonaktifkan secara default, namun dapat diaktifkan dengan mengatur variabel lingkungan DEBUG=http .

Tes

Kami bertujuan untuk memiliki cakupan pengujian yang memadai untuk bagian-bagian penting aplikasi dan tidak menargetkan cakupan pengujian unit 100%. Semua titik akhir API dan segala hal yang terkait dengan autentikasi harus diuji secara menyeluruh.

Untuk menambahkan pengujian baru, tulis pengujian Anda dengan Jest dan tambahkan file dengan ekstensi .test.js di sebelah kode yang diuji.

 # To run all tests
make test

# To run backend tests in watch mode
make watch

Setelah database pengujian dibuat dengan make test Anda dapat menjalankan pengujian frontend dan backend secara langsung.

 # To run backend tests
yarn test:server

# To run a specific backend test
yarn test:server myTestFile

# To run frontend tests
yarn test:app

Migrasi

Sekuelisasi digunakan untuk membuat dan menjalankan migrasi, misalnya:

yarn sequelize migration:generate --name my-migration
yarn sequelize db:migrate

Atau untuk menjalankan migrasi pada database pengujian:

yarn sequelize db:migrate --env test

Aktivitas

Lisensi

Outline berlisensi BSL 1.1.