wagtail torchbox

Torchbox.com di wagtail - pensiun

Peringatan

Versi repo Torchbox.com ini sekarang sudah pensiun. Anda mungkin ingin https://github.com/torchbox/torchbox.com.

Konten rime lama dipertahankan di bawah ini untuk referensi.

 *
*
*
*
*
*
*
*
*
*

Dokumentasi Sejarah

Ini adalah situs web utama Torchbox.com. Bagian karier dari situs ini dapat ditemukan di Torchbox/Karier.

Dokumentasi teknis

Proyek ini berisi dokumentasi teknis yang ditulis dalam penurunan harga di folder /docs . Ini mencakup, antara lain:

• integrasi berkelanjutan
• penyebaran
• Git bercabang
• konvensi proyek

Anda dapat melihatnya menggunakan mkdocs dengan menjalankan:

mkdocs serve

Dokumentasi akan tersedia di: http: // localhost: 8001/

Menyiapkan Bangunan Lokal

Repositori ini mencakup konfigurasi docker-compose untuk menjalankan proyek dalam wadah Docker lokal, dan fabfile untuk menyediakan dan mengelola ini.

Ada sejumlah perintah lain untuk membantu pengembangan menggunakan skrip kain. Untuk melihat semuanya, jalankan:

fab -l

Dependensi

Berikut ini diperlukan untuk menjalankan lingkungan setempat. Versi minimum yang ditentukan dikonfirmasi berfungsi: jika Anda memiliki versi yang lebih lama sudah diinstal, mereka mungkin berfungsi, tetapi tidak dijamin akan melakukannya.

• Docker, versi 19.0.0 atau lebih tinggi
  • Desktop Docker untuk Pemasang Mac
  • Mesin Docker untuk installer Linux
• Docker menyusun, versi 1.24.0 atau lebih tinggi
  • Instal Instruksi (Linux-Only: Compose sudah diinstal untuk pengguna Mac sebagai bagian dari Docker Desktop.)
• Kain, versi 2.4.0 atau lebih tinggi
  • Instal Instruksi
• Python, versi 3.6.9 atau lebih

Perhatikan bahwa pada Mac OS, jika Anda memiliki versi yang lebih lama dari kain yang diinstal, Anda mungkin perlu menghapus yang lama dan kemudian menginstal versi baru dengan PIP3:

pip uninstall fabric
pip3 install fabric

Anda dapat mengelola versi Python yang berbeda dengan menyiapkan pyenv : https://realpython.com/intro-to-pyenv/

Selain itu, untuk berinteraksi dengan lingkungan produksi / pementasan, Anda akan membutuhkan:

• Heroku Cli
• AWS CLI

Menjalankan build lokal untuk pertama kalinya

Jika Anda menggunakan Docker Desktop, pastikan sumber daya: Pengaturan Berbagi File memungkinkan direktori yang dikloning dipasang di wadah web (menghindari mounting kegagalan runtime OCI di akhir langkah build).

Memulai bangunan lokal dapat dilakukan dengan menjalankan:

git clone [email protected]:torchbox/wagtail-torchbox.git
cd wagtail-torchbox
fab build
fab migrate
fab start

Ini akan memulai wadah di latar belakang, tetapi tidak Django. Untuk melakukan ini, sambungkan ke wadah web dengan fab sh dan jalankan honcho start memulai django dan server webpack dev di latar depan.

Kemudian, sambungkan ke wadah yang berjalan lagi ( fab sh ) dan:

dj createcachetable
dj createsuperuser

Situs harus tersedia di mesin host di: http://127.0.0.1:8000/

Jika Anda hanya ingin menjalankan frontend atau backend tooling, perintah yang dijalankan honcho berada di docker/Procfile .

Setelah pertama kali memulai wadah, file statis mungkin tidak ada, atau mungkin ketinggalan zaman. Untuk menyelesaikan ini, cukup jalankan npm run build .

Perkakas Frontend

Berikut perintah umum:

 # Install front-end dependencies.
npm install
# Start the Webpack build in watch mode, without live-reload.
npm run start
# Start the Webpack server build on port 3000 only with live-reload.
npm run build
# Do a one-off Webpack production build.
npm run build:prod

Ada dua cara untuk menjalankan frontend tooling:

• Di Docker. Ini adalah default, paling portabel dan aman, tetapi jauh lebih lambat pada macOS.
• Atau jalankan perintah NPM dari terminal di mesin lokal Anda. Buat file .env di root proyek (lihat .env.example ) dengan FRONTEND=local . fab start tidak akan lagi memulai wadah frontend . Sekarang, saat menjalankan fab start , Docker tidak akan mencoba mengikat ke port yang dibutuhkan untuk Frontend Dev Server, yang berarti mereka dapat dijalankan secara lokal. Semua perkakas masih tersedia di dalam wadah.

Memasang paket Python

Paket Python dapat diinstal menggunakan poetry di wadah web:

 fab sh
poetry add wagtail-guide

Untuk mereset dependensi yang diinstal kembali ke bagaimana mereka dalam file poetry.lock .

 fab sh
poetry install --no-root

Penyebaran

Untuk menggunakan, gabungkan cabang fitur Anda untuk master atau staging cabang. Setelah saluran pipa CI berlalu, itu akan digunakan ke situs Heroku masing -masing secara otomatis.

Ini dilakukan melalui integrasi Heroku GitHub.