Beranda>Terkait pemrograman>Kode sumber lainnya
Unduh

Publiclab.org

Bangun status

Sistem manajemen konten untuk komunitas riset lab publik, aplikasi web plots2 adalah kombinasi dari blog penelitian grup -apa yang kami sebut "catatan penelitian" -dan wiki. Baca lebih lanjut tentang model data di sini.

Mulailah menjalankan (dan berkontribusi pada) basis kode ini segera dengan gitpod:

Ini menampilkan berbagai fitur yang membantu komunitas lab publik berkolaborasi dalam teknologi lingkungan, desain, dokumentasi, dan pengorganisasian komunitas. Awalnya situs Drupal, ditulis ulang pada tahun 2012 dengan Ruby on Rails dan sejak itu diperpanjang tetapi belum sepenuhnya menggantikan model data drupal lama dan desain basis data. Kami ❤️ Open Source dan secara aktif berpartisipasi dalam berbagai program OSS seperti Google Summer of Code (GSOC), Rails Girls Summer of Code (RGSOC), Outreachy, dan Google Code-in (GCI). Beberapa fitur utama termasuk:

  • Portal T&J untuk pemecahan masalah berbasis peer
  • Editor Teks dan Markdown yang kaya
  • Pengeditan dan pelacakan revisi wiki
  • Tagging dan grup dan organisasi konten berbasis topikal
  • Langganan pemberitahuan email untuk topik dan komentar
  • Antarmuka pencarian yang dibangun dari API kami yang sedang berkembang
  • Dasbor pengguna yang menghadirkan aktivitas terbaru
  • Sistem penandaan lokasi yang peka terhadap privasi dan berbasis leaflet dan peta komunitas

Peta jalan

Kami sedang mengembangkan draft peta jalan untuk plots2 dan proyek kode lab publik kami yang lebih luas; Baca lebih lanjut dan komentar di sini.

Deskripsi lengkap tentang fitur, audiens, antar hubungan, dan tujuan proyek perangkat lunak lab publik dapat ditemukan di sini: https://publiclab.org/software-oveview

Daftar isi

  1. Apa yang membuat proyek ini berbeda
  2. Model Data
  3. Berkontribusi
  4. Prasyarat
  5. Instalasi
    • Instalasi standar
    • Instalasi Windows
    • Subsistem Windows untuk Instalasi Linux 2
    • Instalasi Redis
  6. SSL dalam pengembangan
  7. Login
  8. Pengujian
  9. Pemelihara
  10. Cara memulai dan memodifikasi pekerjaan cron
  11. Bundel eksekutif
  12. Balas-demi-Email
  13. Bug dan Dukungan
  14. RECAPTCHA
  15. Internasionalisasi
  16. Keamanan
  17. Pengembang
  18. Pertama kali?
  19. Hacktoberfest

Apa yang membuat proyek ini berbeda

Orang -orang yang membuat platform kami membuat keputusan desain dan teknologi yang sangat berbeda dari proyek lain. Ini berasal dari keyakinan kita yang mendalam bahwa, untuk melihat perubahan di dunia, kita harus membangun dan memelihara sistem yang mencerminkan nilai -nilai dan prinsip kita.

Dari desain hingga arsitektur sistem hingga kosakata dasar dan pola komunikasi, sistem kami telah tumbuh secara organik sejak 2010 untuk mendukung jaringan orang yang kuat, beragam, dan kooperatif yang mampu mengambil masalah lingkungan yang mempengaruhi masyarakat secara global. Platform yang telah kami bangun bersama berbicara tentang sejarah bersama ini dalam banyak hal, besar dan kecil. Ini mencerminkan masukan dari orang-orang yang menghadapi masalah kesehatan yang serius, penyelenggara di lapangan, spesialis kebijakan, peretas perangkat keras, pendidik, dan pegawai negeri sipil.

Komunitas yang luas dan tim lab publik ini telah memfasilitasi ruang di mana kita dapat mendiskusikan, memecah, membangun, membuat prototipe, dan mengkritik proyek dunia nyata. Bersama -sama kami telah membentuk platform yang menggabungkan karya -karya yang akrab tetapi pada akhirnya terlihat dan terasa sangat berbeda dari hal lain di internet. Terlepas dari pertumbuhan platform kami, ia tetap berkomitmen untuk mendengar suara orang lain, saling menghormati dan mendukung, kesadaran akan hambatan dan tantangan yang disajikan oleh kesenjangan dalam keahlian dan pengetahuan, dan sensitivitas terhadap ketidaksetaraan dan ketidakseimbangan kekuatan yang diabadikan oleh banyak moda utama produksi pengetahuan dan pengembangan teknologi dan ilmiah.

Tujuan bersama kami untuk mendemokratisasi teknik do-it-it-yourself yang tidak dapat diakses memungkinkan kami untuk menciptakan jaringan kolaboratif para praktisi yang secara aktif membayangkan kembali hubungan manusia dengan lingkungan. Tujuan kami didukung dan difasilitasi oleh sistem yang mempertanyakan dan bahkan menantang bagaimana pekerjaan kolaboratif dapat terjadi.

Model Data

Diagram

(Atas: Draf Model Data kami)

Berkontribusi

Kami menyambut kontribusi, dan terutama tertarik untuk menyambut kontributor pertama kali. Baca lebih lanjut tentang cara berkontribusi di bawah ini! Kami terutama menyambut kontribusi dari orang-orang yang termasuk dalam kelompok yang kurang terwakili dalam perangkat lunak gratis dan open source!

Kode Etik

Harap baca dan patuhi kode perilaku kami; Komunitas kami bercita-cita untuk menjadi tempat yang penuh hormat baik selama interaksi online dan langsung.

Prasyarat

Untuk pemasangan, prasyarat termasuk SQLite3 dan RVM. Klik di sini untuk daftar dan instruksi lengkap.

Instalasi

Instalasi standar

  1. Fork Repo kami dari https://github.com/publiclab/plots2.
  2. Di konsol, unduh salinan repo forked Anda dengan git clone https://github.com/your_username/plots2.git di mana your_username adalah nama pengguna github Anda.
  3. Masukkan direktori Plots2 baru dengan cd plots2 .
  4. Atur remote hulu ke URL repositori asli sehingga git tahu di mana harus mengambil pembaruan dari di masa mendatang: git remote add upstream https://github.com/publiclab/plots2.git
  5. Langkah -langkah untuk menginstal permata:
    • Anda mungkin perlu pertama kali menjalankan bundle install jika Anda memiliki permata yang lebih tua di lingkungan Anda dari pekerjaan rel sebelumnya. Jika Anda mendapatkan pesan kesalahan seperti Your Ruby version is 2.xx, but your Gemfile specified 2.7.3 maka Anda harus menginstal Ruby Version 2.7.3 menggunakan rvm atau rbenv .
      • Menggunakan RVM : rvm install 2.7.3 diikuti oleh rvm use 2.7.3
      • Menggunakan RBENV : rbenv install 2.7.3 diikuti oleh rbenv local 2.7.3
    • Jalankan bundle config set without 'production mysql' dari folder root Rails untuk mengatur proyek Anda untuk mengecualikan pustaka yang hanya diperlukan dalam produksi.
    • Pasang permata dengan bundle install dari folder root Rails.
  6. Jalankan cp db/schema.rb.example db/schema.rb untuk membuat salinan db/schema.rb.example dalam db/schema.rb .
  7. Anda dapat memilih untuk menggunakan MySQL2 atau SQLITE3 sebagai database Anda. Kami merekomendasikan menggunakan sqlite3 sebagai database Plots2 Anda karena beberapa kontributor kami telah melaporkan masalah saat menggunakan mysql2 .
    • Jika mysql2, jalankan cp config/database.yml.mysql.example config/database.yml untuk membuat salinan config/database.yml.mysql.example di config/database.yml
    • Jika sqlite3, jalankan cp config/database.yml.sqlite.example config/database.yml untuk membuat salinan config/database.yml.sqlite.example di config/database.yml . Mohon perhatikan jika Anda memilih untuk menggunakan sqlite beberapa tes mungkin gagal. Proyek ini awalnya disetel untuk menggunakan MySQL dan beberapa tes dirancang untuk MySQL DB. Tidak perlu alarm, kami bekerja untuk memperbaikinya dan ini tidak akan mengganggu proses pengembangan Anda
  8. Jalankan rake db:setup untuk mengatur database
  9. Instal aset statis (seperti pustaka javascript eksternal, font) dengan yarn install
  10. Pengaturan React & WebPacker dengan menjalankan rails webpacker:install && rails webpacker:install:react && rails generate react:install (untuk pekerjaan SSL lokal, lihat SSL di bawah)
  • Jika Anda mendapatkan prompt untuk menimpa file dalam langkah ini, pilih tidak. Prompt akan menjadi sesuatu seperti "overwrite /home/plots2/config/webpacker.yml? (Masukkan" h "untuk bantuan) [ynaqdhm]" :- type "n" dan masukkan.
  1. Mulai server dengan passenger start dan navigasikan ke http://localhost:3000/ di browser Anda.
  2. Wheeeee! Anda bangun dan berlari! Masuk dengan nama pengguna tes "pengguna", "moderator", atau "admin", dan kata sandi "kata sandi".
  3. Jalankan rails test untuk mengonfirmasi bahwa pemasangan Anda berfungsi dengan baik. Anda juga dapat menjalankan rails test:system untuk Tes Sistem. ( Catatan: Jika Anda memilih SQLite sebagai database Anda, beberapa tes mungkin gagal; tolong abaikan ini, kami berupaya memperbaikinya. Jika server Anda dimulai dengan benar, Anda sudah siap )

Instalasi Windows

Kami menyarankan Anda bekerja di lingkungan virtual, atau pada sistem boot ganda untuk menghindari masalah ketergantungan karena sistem UNIX cenderung bekerja lebih halus dengan ruby ​​dan rails. Ini tidak hanya akan menguntungkan Anda sekarang untuk Plots2, tetapi juga di masa depan saat mengerjakan proyek Ruby lainnya, OS berbasis Linux atau Mac akan membuat perkembangan Anda lebih mudah.

  1. Subsistem Windows untuk Linux (Direkomendasikan)
  2. Booting ganda, opsi2, panduan video
  3. Menyiapkan Linux Virtual Env

Subsistem Windows untuk Instalasi Linux 2

Sebelum melanjutkan dengan langkah -langkah instalasi dalam readme ini, pengguna subsistem Windows untuk Linux 2 (WSL 2) harus membuka terminal WSL 2 dan mengetikkan perintah di bawah ini.

  1. Instal dependensi yang diperlukan dari sumber Ruby dengan perintah berikut:
  • sudo apt update
  • sudo apt install curl g++ gcc autoconf automake bison libc6-dev
  • sudo apt install libffi-dev libgdbm-dev libncurses5-dev libsqlite3-dev libtool
  • sudo apt install libyaml-dev make pkg-config sqlite3 zlib1g-dev libgmp-dev
  • sudo apt install libreadline-dev libssl-dev
  1. Tambahkan Kunci GPG & Instal RVM:
  • Instal GNUPG2 jika Anda belum melakukannya: sudo apt install gnupg2
  • gpg2 --recv-keys 409B6B1796C275462A1703113804BB82D39DC0E3 7D2BAF1CF37B13E2069D6956105BD0E739499BDB
  • curl -sSL https://get.rvm.io | bash -s stable
  1. Muat variabel lingkungan skrip menggunakan perintah sumber:
  • source ~/.rvm/scripts/rvm
  1. Instal dan gunakan versi Ruby tertentu:
  • rvm install ruby-xxx (this projects Ruby version)
  • rvm --default use ruby-xxx (replace xxx with this project's Ruby version)
  1. Untuk referensi lebih lanjut, baca di sini

Instalasi Redis

Public Lab menggunakan Redis dan mungkin diperlukan untuk beberapa fungsionalitas saat menjalankan aplikasi secara lokal.

  1. Instal redis jika Anda belum:
  • Menggunakan MacOS : brew install redis
  • Menggunakan Linux : sudo yum -y install redis
  • Menggunakan Ubuntu WSL2 :
    • Perbarui & Tingkatkan Ubuntu: sudo apt update && apt upgrade
    • Instal Redis: sudo apt install Redis-server
    • Buka Redis.config File: sudo nano /etc/redis/redis.conf
    • Perbarui file dengan mengubah jalur yang diawasi No ke SystemD yang diawasi (Ubuntu menggunakan SystemD)
    • Mulai Redis: sudo service redis-server start
    • Buka Redis Cli: redis-cli
    • Tes Redis: Ketik ping & respons harus pong
    • Keluar CLI: Ketik quit
    • Luar biasa ? Semua selesai ✅
  1. Jalankan Redis Server:
  • Menggunakan MacOS : brew services start redis
  • Menggunakan Linux : redis-server
  1. Jalankan Sidekiq: bundle exec sidekiq
  2. Jika Sidekiq dimulai dengan benar Redis sekarang dikonfigurasi dan berfungsi!

SSL dalam pengembangan

Di lab publik kami menggunakan OpenSSL GEM untuk menyediakan SSL (Secure Sockets Layer) untuk Secure Connection (HTTPS) dalam mode pengembangan. Anda dapat menjalankan koneksi HTTPS di LocalHost melalui langkah -langkah berikut:

  1. Gunakan passenger start --ssl --ssl-certificate config/localhost.crt --ssl-certificate-key config/localhost.key --ssl-port 3001 .
  2. Buka https: // localhost: 3001.
  3. Tambahkan pengecualian keamanan dari pengaturan muka browser. Anda juga dapat menggunakan http (koneksi tidak aman) pada nomor port 3000 dengan pergi ke 'http: // localhost: 3000'. Kami menggunakan nomor port 3001 untuk 'https' dan nomor port 3000 untuk koneksi 'http'. Koneksi yang aman diperlukan untuk otentikasi oAuth dll.

Login

Setelah Anda menyelesaikan instalasi, gunakan salah satu kredensial ini untuk masuk ke situs web PL di lingkungan pengembangan/pengujian lokal Anda untuk mendapatkan izin tambahan hanya untuk masuk pengguna. Masing -masing dilengkapi dengan serangkaian izin sendiri; Namun demikian, pengalaman di seluruh mereka hampir sama.

Nama pengguna : admin , moderator , atau user

Kata sandi : password

Untuk informasi lebih lanjut tentang sistem login, lihat halaman ini

Pengujian

Klik di sini untuk deskripsi pengujian yang komprehensif dan di sini untuk mempelajari tentang tes sistem.

Pemelihara

  • Lihat /doc/Maintainers.md untuk kebijakan lab publik tentang pengelola fitur!

Cara memulai dan memodifikasi pekerjaan cron

  1. Kami menggunakan kapan pun GEM untuk menjadwalkan pekerjaan cron.
  2. Semua pekerjaan cron ditulis dalam sintaks Ruby yang mudah menggunakan permata ini dan dapat ditemukan di config/jadwal.rb.
  3. Buka file config/jadwal.rb untuk membuat dan memodifikasi pekerjaan cron.
  4. Klik di sini untuk mempelajari lebih lanjut tentang cara menulis pekerjaan cron.
  5. Setelah memperbarui file config/jadwal.rb, jalankan perintah whenever --update-crontab untuk memperbarui pekerjaan cron.
  6. Untuk melihat daftar pekerjaan cron yang diinstal menggunakan command crontab -l
  7. Untuk detail lebih lanjut tentang permata ini, kunjungi repositori resmi kapan pun permata.

Bundel eksekutif

Bagi sebagian orang, perlu untuk menyiapkan perintah terkait permata Anda dengan bundle exec . Misalnya, bundle exec passenger start . Menambahkan bundle exec memastikan Anda menggunakan versi penumpang yang baru saja Anda instal dengan Bundler. bundle exec rake db:setup , bundle exec rake db:seed adalah contoh lain dari mana hal ini mungkin diperlukan.

Balas-demi-Email

Lab publik sekarang mendukung fitur "Balas melalui email ke komentar". Untuk detail lebih lanjut, buka dokumentasi email

Bug dan Dukungan

Untuk melaporkan bug dan meminta fitur, silakan gunakan pelacak masalah github

Untuk dukungan tambahan, bergabunglah dengan situs web lab publik dan milis di http://publiclab.org/lists. Untuk permintaan mendesak, kirim email ke [email protected]

RECAPTCHA

Aplikasi ini menggunakan recaptcha melalui permata recaptcha hanya dalam produksi. Untuk informasi lebih lanjut, klik di sini.

Internasionalisasi

Publiclab.org sekarang mendukung internasionalisasi dan lokalisasi, meskipun kami berada pada tahap awal. Ini telah dicapai dengan Rails-I8N.

Untuk melihatnya beraksi, klik drop-down 'Bahasa' yang terletak di bagian footer halaman. Semua pedoman dan praktik terbaik untuk I18n dapat ditemukan di sini.

Terjemahan diatur dalam file YAML di sini, yang diatur dengan cara yang sama untuk melihat file. Contoh untuk menambahkan terjemahan dapat ditemukan di sini.

Karena implementasi sistem terjemahan baru kami, kami sekarang menggunakan penolong translation() , ditemukan di sini. Ini memberikan beberapa fitur terjemahan tambahan seperti memasukkan prompt yang terlihat oleh pengunjung situs jika belum ada terjemahan. Anda dapat mempelajari lebih lanjut tentang sistem terjemahan kami dengan membaca dokumen sistem terjemahan kami.

Untuk menambahkan bahasa baru atau untuk dukungan tambahan, silakan tulis ke [email protected]

Keamanan

Untuk melaporkan kerentanan keamanan atau untuk pertanyaan tentang keamanan, silakan hubungi [email protected]. Kelompok kerja web kami akan menilai dan merespons dengan segera.

Pengembang

Membantu meningkatkan perangkat lunak lab publik!

  • Bergabunglah dengan daftar diskusi [email protected] untuk terlibat
  • Cari masalah terbuka di https://github.com/publiclab/plots2/labels/help-wanted
  • Kami secara khusus meminta bantuan dengan masalah yang diberi label dengan tag bantuan yang diwantak
  • Temukan banyak info tentang berkontribusi di http://publiclab.org/wiki/developers
  • Tinjau Pedoman Kontributor Khusus di http://publiclab.org/wiki/contributing-to-public-lab-software
  • Beberapa devs nongkrong di IRC Webchat
  • Bergabunglah dengan Obrolan Gitter kami
  • Cobalah beberapa tugas yang mendukung
  • Terlibat dengan check-in komunitas mingguan kami. Untuk Pedoman: https://github.com/publiclab/plots2/tree/main/doc/checkins.md
  • Anda dapat membantu kami dengan membuka masalah timer pertama atau FTO. Templat untuk membuka masalah dapat ditemukan di https://github.com/publiclab/plots2/blob/main/.github/issue_template/--first-timers-only.md

Pertama kali?

Baru mengenal perangkat lunak open source/gratis? Berikut adalah pilihan masalah yang kami buat terutama untuk pemula . Kami di sini untuk membantu, jadi tanyakan saja apakah seseorang terlihat menarik: https://code.publiclab.org

Berikut ini tautan ke alur kerja git kami.

Hacktoberfest

Ingin berkontribusi pada PublicLab sebagai bagian dari Hacktoberfest? Lihat dokumen yang berkontribusi Hacktoberfest kami

Biarkan kodenya bersama Anda.

Selamat OpenSourcing. ?

Platform yang ❤️ OSS

Memperluas
Informasi Tambahan
Aplikasi Terkait
Direkomendasikan untuk Anda
Informasi Terkait Semua