Home

➡️ this WiKi refers to framework versions v7+ and above

(:link: = external links)

Index

Project overview

• Framework architecture birds-eye view
• DB structure overview 🚧
• Continuous Delivery Build Pipeline setup: full spec suite run with code coverage & auto-deploy
• Goggles credentials: management and creation

Goggles framework components

• DB engine
• API app
• Main app
• Chrono sub-app (moved into goggles_main)
• Admin app 🚧

Usage as Docker containers

• GogglesMain Docker usage: GogglesMain as reference implementation (overall / birds-eye look)
• GogglesAPI Docker usage: GogglesApi as reference implementation (in-depth guide)
• GogglesAdmin Docker usage: WIP 🚧

---

Best-practices

• TDD/BDD work-flow
• Generic development best practices
• More in-depth coding & testing best practices, with design patterns and tips (it applies well to other languages)
• Blog post: Tidy Views and Beyond with Decorators 🔗

Dev-specific

• generic Dev environment setup
• RVM
• Rbenv (alternative to RVM)
• install & configure Guard & Spring or Zeus
• Git usage and references
• Git LFS: how to manage large files with Git
• Bundle & gemset update, relative to an Engine that includes large files using GIT-LFS

Debugging & tests

• Debugging Cucumber/Capybara with Selenium driver
• Cucumber: same feature, multiple runs
• Setup a quick Mock-up API server for testing responses

DevOps

Maintenance

• Maintenance mode
• Capistrano supporting tasks
• Do a "DB rebuild from dump" manually, step-by-step

Misc

General WiKi pages about specific topics.

• set-up/compile RVM Ruby with OpenSSL depending on version for latest Ubuntu versions
• SSH keys setup
• SSL certificate setup
• Logrotate setup
• Crontab setup
• Monit "generic" setup
• Semi-manual or in-depth log analysis
• Apache2 protected content behind login wall
• Apache2 as a reverse proxy for containers
• Dev-containers intro & setup

Cold-Deploy Server set-up

Step-by-step scripted procedure towards a Cold-deploy Server setup, divided in chapters.

1. Goal architecture and key gotchas
2. Initial baremetal setup with dedicated user & Web server installation
3. Docker & docker-compose installation
4. DB setup
5. Reverse Proxy setup with Basic Auth for staging
6. Internal Mail Server setup
7. Mail encryption and additional DNS record setup
8. Connecting running containers to the MTA (Postfix)
9. Monit setup
10. Extras: manual intervention examples

---

Knowledge base

Store here any additional, relevant & useful article or blog post link.

Docker

• Part 1: intro & basic concepts
• Part 2: setup & useful commands
• Part 3: docker-compose
• misc examples
• Blog: Docker ARG, ENV and .env - a Complete Guide 🔗
• Blog: Access Private Repositories from Your Dockerfile Without Leaving Behind Your SSH Keys 🔗
• Blog: Access Private Repositories from Your Dockerfile Without Leaving Behind Your SSH Keys 🔗
• Blog: Deploying Rails 6 Assets with Docker and Kubernetes 🔗

Webpacker, EM6 & Rails 6

• GoRails tutorial: how to include Bootstrap 4 into a new Rails 6 project :video: 🔗

• Upgrading Webpacker 🔗

• Posts about including jQuery in a Rails 6 project:

  • Blog post: adding jQuery to Rails 6 WebPacker 🔗
  • StackOverflow post about Bootstrap JS functions not loading in Rails 6/Webpacker 🔗
  • Goggle Developers blog - web fundamentals: add touch support to your site 🔗

• Using Webpacker in a Rails Engine:

  • Blog post: sharing assets using Engines 🔗
  • Webpacker v.5 docs about configuring and using Webpacker inside Rails Engines 🔗
  • Blog post: using Webpacker in Rails Engines 🔗
  • Blog post: bending Webpacker into Rails Engines 🔗

Misc

• nvm & NodeJS setup
• yarn setup

StimulusJS

• StimulusJS handbook 🔗
• StimulusJS reference 🔗
• How to add StimulusJS to a Rails 6 app 🔗 (may be not well updated or slightly wrong for current versions)