คำเตือน
ตอนนี้ repo torchbox.com รุ่นนี้จะเกษียณแล้ว คุณอาจต้องการ https://github.com/torchbox/torchbox.com
เนื้อหา reame เก่าได้รับการเก็บรักษาไว้ด้านล่างสำหรับการอ้างอิง
- - - - - - - - - -
นี่คือเว็บไซต์หลัก Torchbox.com ส่วนอาชีพของเว็บไซต์นี้สามารถดูได้ที่ Torchbox/Careers
โครงการนี้มีเอกสารทางเทคนิคที่เขียนใน Markdown ในโฟลเดอร์ /docs สิ่งนี้ครอบคลุมในหมู่คนอื่น ๆ :
คุณสามารถดูได้โดยใช้ mkdocs โดยใช้งาน:
mkdocs serveเอกสารจะมีอยู่ที่: http: // localhost: 8001/
พื้นที่เก็บข้อมูลนี้รวมถึงการกำหนดค่า docker-compose สำหรับเรียกใช้โครงการในคอนเทนเนอร์ Docker ท้องถิ่นและ fabfile สำหรับการจัดเตรียมและการจัดการสิ่งนี้
มีคำสั่งอื่น ๆ อีกมากมายที่จะช่วยในการพัฒนาโดยใช้สคริปต์ผ้า หากต้องการดูพวกเขาทั้งหมด Run:
fab -lต่อไปนี้จำเป็นต้องใช้สภาพแวดล้อมในท้องถิ่น เวอร์ชันขั้นต่ำที่ระบุได้รับการยืนยันว่าใช้งานได้: หากคุณติดตั้งเวอร์ชันเก่าแล้วพวกเขา อาจ ใช้งานได้ แต่ไม่รับประกันว่าจะทำเช่นนั้น
โปรดทราบว่าใน Mac OS หากคุณติดตั้งผ้ารุ่นเก่าคุณอาจต้องถอนการติดตั้งรุ่นเก่าแล้วติดตั้งเวอร์ชันใหม่ด้วย PIP3:
pip uninstall fabric
pip3 install fabric คุณสามารถจัดการรุ่น Python ที่แตกต่างกันได้โดยการตั้งค่า pyenv : https://realpython.com/intro-to-pyenv/
นอกจากนี้สำหรับการโต้ตอบกับสภาพแวดล้อมการผลิต / การจัดเตรียมคุณจะต้อง:
หากคุณใช้เดสก์ท็อป Docker ให้แน่ใจว่าทรัพยากร: การตั้งค่าการแชร์ไฟล์อนุญาตให้ติดตั้งไดเรกทอรีที่โคลนในเว็บคอนเทนเนอร์ (หลีกเลี่ยง mounting ความล้มเหลวของรันไทม์ OCI ในตอนท้ายของขั้นตอนการสร้าง)
การเริ่มต้นสร้างท้องถิ่นสามารถทำได้โดยการวิ่ง:
git clone [email protected]:torchbox/wagtail-torchbox.git
cd wagtail-torchbox
fab build
fab migrate
fab start สิ่งนี้จะเริ่มต้นคอนเทนเนอร์ในพื้นหลัง แต่ไม่ใช่ Django ในการทำเช่นนี้ให้เชื่อมต่อกับเว็บคอนเทนเนอร์ด้วย fab sh และเรียกใช้ honcho start ที่จะเริ่มต้นทั้ง django และเซิร์ฟเวอร์ webpack dev ในเบื้องหน้า
จากนั้นเชื่อมต่อกับคอนเทนเนอร์ที่ทำงานอีกครั้ง ( fab sh ) และ:
dj createcachetable
dj createsuperuserไซต์ควรมีอยู่ในเครื่องโฮสต์ที่: http://127.0.0.1:8000/
หากคุณต้องการเรียกใช้เครื่องมือส่วนหน้าหรือแบ็กเอนด์คำสั่ง honcho Runs จะอยู่ใน docker/Procfile
เมื่อเริ่มต้นคอนเทนเนอร์เป็นครั้งแรกไฟล์คงที่อาจไม่มีอยู่หรืออาจล้าสมัย ในการแก้ไขปัญหานี้เพียงเรียกใช้ npm run build
นี่คือคำสั่งทั่วไป:
# 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มีสองวิธีในการเรียกใช้เครื่องมือส่วนหน้า:
.env ในรูทโครงการ (ดู .env.example ) ด้วย FRONTEND=local fab start จะไม่เริ่มคอนเทนเนอร์ frontend อีกต่อไป ตอนนี้เมื่อเรียกใช้ fab start , Docker จะไม่พยายามผูกกับพอร์ตที่จำเป็นสำหรับเซิร์ฟเวอร์ dev ส่วนหน้าซึ่งหมายความว่าพวกเขาสามารถทำงานได้ในเครื่อง เครื่องมือทั้งหมดยังคงมีอยู่ในคอนเทนเนอร์ แพ็คเกจ Python สามารถติดตั้งได้โดยใช้ poetry ในเว็บคอนเทนเนอร์:
fab sh
poetry add wagtail-guide
ในการรีเซ็ตการพึ่งพาที่ติดตั้งกลับไปเป็นวิธีที่พวกเขาอยู่ใน poetry.lock file:
fab sh
poetry install --no-root
ในการปรับใช้ให้ผสานสาขาคุณลักษณะของคุณเป็น master หรือ staging สาขา เมื่อท่อ CI ผ่านไปแล้วมันจะถูกนำไปใช้กับไซต์ Heroku ที่เกี่ยวข้องโดยอัตโนมัติ
สิ่งนี้ทำผ่านการรวม Heroku GitHub