ITB 2023 Real World ColdBox App Architecture - Nolan Erck.pdf
0 likes32 views
The document details the architecture and development process of the Fuse web app, built using CFML, ColdBox, MySQL, and Alpine.js, emphasizing its features like login, authentication, and permission management. It discusses the importance of using established frameworks such as ColdBox for scalability, testing, and maintenance, while also addressing automated testing with TestBox and deployment processes using Docker and GitHub Actions. Additionally, the document highlights resources available for learning and support within the CFML community.
ITB 2023 Real World ColdBox App Architecture - Nolan Erck.pdf
- 1. INTO THE BOX 2023 Nolan Erck REAL WORLD COLDBOX APP ARCHITECTURE
- 2. Owner @ South of Shasta Organizer @ Sac Interactive Tech Meetup (formerly Sacramento CFUG) Recovering Video Game Developer (Grim Fandango, SimPark, Star Wars Phantom Menace, etc) Music Junkie About Me
- 5. Also VP of Engineering for e-Mission Control SaaS startup in Sacramento Building the FuSE web app About Me
- 6. Streamlines using your local Clean Fuel Program / LCFS Free to use SaaS Platform Tech stack at a glance: Lucee, MySQL, Alpine.js, AWS What Does The FuSE App Do?
- 7. Login, Authentication, Authorization, Permissions, AWS, Validation, etc. Want it to be f lexible, organized. Started with a blank slate. Zero existing code. Where to begin? CFML, ColdBox, Alpine.js, MySQL The same needs as other apps
- 8. Try to be objective when picking a tech stack Lucee = free and open source Startups = costs are a real concern Strong ties to the CFML community Might use ACF for some features later WHY CFML?
- 9. Industry standard, not just for CFML! Any good developer can pick it up quickly. Learn your design patterns! Opens up new job opportunities to you! OO Primer video series on CFCasts.com that I made with Ortus to get you started. WHY MVC?
- 10. Almost* never a good reason to roll your own framework! Doing so usually means: a) They are not really using the MVC pattern, or b) They donât understand MVC enough to make decisions on that front * One very unique app we did for the semiconductor industry needed a custom framework. One. In 20+ years of web development. One. Uno. WHY MVC?
- 11. SoâŚFW/1, CF Wheels, or ColdBox?
- 12. Enter ColdBox (âŚand the Box ecosystem)
- 13. At a minimum MVC structure DI / AOP Command Line tools/scaffolding What ColdBox Gives Me
- 14. ALSO⌠Server side testing Professional support There is no FW/1 or CFWheels Conference, nor paid support option An ecosystem⌠What ColdBox Gives Me
- 15. Compatible modules forgebox.io More than just ColdBox modules! CommandBox Tooling Docker images The ColdBox Ecosystem
- 16. So anyway, back to the FuSE appâŚ
- 17. Same concerns as any other web app
- 18. How many of you have rolled your own âcheck if this password is valid / login / logoutâ code? Repetitive, boring to build. But necessary. Users also need permission levels. Forgebox has cbAuth & cbSecurity Users need to log in
- 20. UserService.cfc 3 methods isValidCredentials retrieveUserByUsername retrieveUserById Letâs look at the code! cbAuth
- 21. Give users permissions Admin User, Customer logins, etc Easily mark blocks of code for just speci f ic User Roles Easily con f igure the levels of permission cbSecurity
- 22. cbSecurity
- 23. cbSecurity
- 24. cbSecurity
- 25. cbSecurity
- 26. Want it to be RESTful (industry standard) Versioned Use the core app codebase, without copy/pasting business logic Testable Enter ColdBox Modules & REST Template API
- 27. modules_app/api/v1 API code calls Services and Models however it needs to Bug f ix in Service f ixes both the core app and API at the same time ColdBox Modules & REST Template
- 28. REST Template
- 29. REST Template
- 30. Every web app has this Optional vs required f ields Constraints and business rules Need a way to report the errors back to the caller Enter cbValidation Required Fields / Validation
- 31. cbValidation
- 32. S3, Elastic Search, various other AWS things No of f icial CFML library for AWS Enter ForgeBox: aws-cfml Library for interacting with AWS APIs AWS
- 33. AWS-CFML
- 34. AWS-CFML
- 35. Automated testing saves huge chunks of time and money! Way cheaper to f ind and f ix bugs early, before in Production Enter TestBox You can test any CFML app with TestBox! Not just ColdBox apps! Runs from web browser and command line Command line = it can be scripted GitHub Actions Automated Testing
- 36. TestBox http://localhost/tests/runner.cfm box testbox run reporter=html/text/various other things /tests folder Can test any CFML app with TestBox! Not just ColdBox apps!
- 38. Cypress Can test ANY web app with Cypress! Not just ColdBox! Not just CFML! npx cypress run Command line = it can be scripted /cypress/e2e folder
- 41. Want an easy way to push code to servers No manual steps, FTP, RDP, things prone to error No physical web servers to maintain, just Docker containers (except the database) Deployment Process
- 44. GitHub Actions + AWS App Runner Deploy CommandBox Docker image to a branch Separate cfcon f ig.json / env f iles for each environment Dev, Staging, Production GitHub Action + AWS App Runner does the rest 10 minutes later, we have a new version deployed Deployment Process
- 45. Everything is scripted go.sh for spinning up the container Deployment Process Ci script for deployment. Ci calls the Go script
- 46. And thatâs our stack!
- 47. FAQs
- 48. Why arenât you using the latest versions of these *box things?
- 49. Why Alpine.js?
- 50. Did you do all this at once?
- 51. Just Start
- 52. Learning in 30 Minutes A Day
- 53. This Conference! CFCasts.com CFML Slack channels (ugh!) Ortus Solutions South of Shasta More Resources
- 54. You can f ind me here: southofshsata.com Twitter @southofshasta, @nolanerck nolan@southofshasta.com e-missioncontrol.com Any Questions?
- 55. THANK YOU Thanks to our sponsors