bulldoggy reminders app

Bulldoggy: แอพเตือนความจำ

Bulldoggy เป็นแอปพลิเคชันเว็บตัวอย่างเล็ก ๆ สำหรับการติดตามการแจ้งเตือน มันใช้:

• Python เป็นภาษาการเขียนโปรแกรมหลัก
• fastapi สำหรับแบ็กเอนด์
• HTMX 1.8.6 สำหรับการจัดการการโต้ตอบแบบไดนามิก (แทนที่จะเป็นจาวาสคริปต์ดิบ)
• เทมเพลต Jinja ที่มี HTML และ CSS สำหรับส่วนหน้า
• TinyDB สำหรับฐานข้อมูล
• นักเขียนบทละครและ pytest สำหรับการทดสอบ

เรียนรู้วิธีการทำงาน

การพัฒนาและการทดสอบเป็นสองด้านของเหรียญเดียวกัน:

1. หากต้องการเรียนรู้วิธี พัฒนา แอพ Bulldoggy ให้ดูคำปราศรัย Pytexas 2023 ของฉัน Python เต็มสแต็ค
2. หากต้องการเรียนรู้วิธี ทดสอบ แอพ Bulldoggy ให้ดูคำปราศรัยของฉัน Djangocon US 2023 ของฉัน ทดสอบแอพพลิเคชั่นเว็บสมัยใหม่เช่นแชมป์

คำปราศรัยทั้งสองนี้เป็น bookends สำหรับกันและกัน

การติดตั้งการอ้างอิง

คุณจะต้องใช้ Python เวอร์ชันล่าสุดเพื่อเรียกใช้แอพนี้ เพื่อติดตั้งการพึ่งพาโครงการ:

 pip install -r requirements.txt

ขอแนะนำให้ติดตั้งการพึ่งพาในสภาพแวดล้อมเสมือนจริง

รันแอพ

เพื่อเรียกใช้แอพ:

 uvicorn app.main:app --reload

จากนั้นเปิดเบราว์เซอร์ของคุณไปที่ http://127.0.0.1:8000 เพื่อโหลดแอพ

เรียกใช้แอพด้วย Docker

สร้างภาพด้วย:

 docker build -t bulldoggy-reminders-app:0.1 .

เพื่อเรียกใช้ภาพ:

 docker run -it --rm --name bulldoggy-reminders-app -p 8000:8000 bulldoggy-reminders-app:0.1

เข้าสู่ระบบแอป

ไฟล์ config.json ประกาศผู้ใช้สำหรับแอป คุณสามารถใช้ข้อมูลรับรองผู้ใช้ที่กำหนดค่าใด ๆ หรือเปลี่ยนตามความชอบของคุณ ชื่อผู้ใช้ "เริ่มต้น" คือ pythonista ด้วยรหัสผ่าน I<3testing

การตั้งค่าพา ธ ฐานข้อมูล

แอพใช้ TinyDB ซึ่งเก็บฐานข้อมูลเป็นไฟล์ JSON ฐานข้อมูลเริ่มต้น filepath คือ reminder_db.json คุณสามารถเปลี่ยนเส้นทางนี้ใน config.json หากคุณเปลี่ยน FilePath แอปจะสร้างฐานข้อมูลที่ว่างเปล่าใหม่โดยอัตโนมัติ

ใช้แอพ

Bulldoggy เป็นแอพเตือนความจำ หลังจากเข้าสู่ระบบคุณสามารถสร้างรายการเตือนความจำ

รายการเตือนความจำแต่ละรายการจะปรากฏทางด้านซ้ายและรายการในรายการจะปรากฏทางด้านขวา คุณสามารถเพิ่มลบหรือแก้ไขรายการและรายการ คุณสามารถตีรายการที่เสร็จสมบูรณ์ได้

อ่านเอกสาร

หากต้องการอ่านเอกสาร API ให้เปิดหน้าต่อไปนี้:

• /docs สำหรับเอกสาร OpenAPI แบบคลาสสิก
• /redoc สำหรับเอกสาร redoc ที่ทันสมัยมากขึ้น

ทำไมฉันถึงสร้างแอพนี้ใน Python?

โดยส่วนตัวแล้วฉันรัก Python และฉันต้องการสาธิตวิธีการ สร้างเว็บแอพพลิเคชั่นที่ทันสมัยเต็มรูป แบบ ด้วย Python

JavaScript มีการผูกขาดใกล้กับการพัฒนาเว็บส่วนหน้า เบราว์เซอร์ต้องการรหัส JavaScript เพื่อดำเนินการโต้ตอบหน้าเว็บแบบไดนามิก อย่างไรก็ตาม HTMX เสนอวิธีแปลกใหม่ในการหลีกเลี่ยงข้อ จำกัด นี้: มันมีคุณสมบัติ HTML พิเศษเพื่อแสดงถึงการโต้ตอบแบบไดนามิกสำหรับองค์ประกอบ ภายใต้ประทุน HTMX ใช้ AJAX เพื่อออกคำขอ HTTP และสลับเนื้อหาไฮเปอร์เท็กซ์สำหรับองค์ประกอบที่กำหนดเป้าหมายด้วยแอตทริบิวต์พิเศษ JavaScript ยังอยู่ที่นั่น - คุณไม่จำเป็นต้องแตะต้อง!

สิ่งนี้ช่วยให้เฟรมเวิร์กเว็บเป็นภาษาเช่น Python, Go, Java และอื่น ๆ เพื่อนำเสนอเนื้อหาเว็บเพจแบบไดนามิกโดยตรงใน HTML โดยไม่ ต้องให้นักพัฒนาต้องใช้รหัส JavaScript ใด ๆ อย่างชัดเจน HTMX ช่วยให้คุณเป็นนักพัฒนาเพื่อสร้างเว็บแอพที่สวยงามในขณะที่ยังคงอยู่ในสแต็คเทคโนโลยีที่คุณเลือก!

หากต้องการเรียนรู้เพิ่มเติมเกี่ยวกับการออกแบบของแอพนี้โปรดดูคำปราศรัย Pytexas 2023 ของฉัน Python เต็มสแต็ค

การให้เครดิต

• ฉันใช้ Dall-E เพื่อสร้างโลโก้ Bulldoggy
• ฉันใช้ CHATGPT เพื่อสร้างส่วนของ HTML และ CSS
• การพูดคุยของ Michael Kennedy ที่ Pybay 2021 และ Python Web Conference 2022 ใน Python + HTMX เป็นแรงบันดาลใจให้ฉัน
• เอกสารและตัวอย่าง HTMX สอนวิธีใช้ HTMX
• เพื่อนสองสามคนจาก Twitter และ LinkedIn ช่วยฉันทดสอบแอพ:
  • Juan Rosello
  • Sharib Islam
  • การบำบัดด้วยแสงสว่าง
  • Enigma5312
  • MRPOSR

รายการสิ่งที่ต้องทำ

• ทำการทดสอบ API โดยอัตโนมัติ
• ทำการทดสอบ UI โดยอัตโนมัติ
• ทำการทดสอบหน่วยโดยอัตโนมัติ