Guides

Working on a Bogie app

One guide per feature: the commands to run, in order, and what they produce. Read Getting started first; the rest stand on their own after that.

• Getting started

  Install Bogie, generate a new service, and get it migrating, seeded and serving.

• Models and migrations

  Add a table with g model, change one with g migration, and run it through db:*.

• Resources, controllers and routing

  Scaffold a whole resource or write a controller by hand, and see how either gets registered.

• Authentication

  Guard a route group with a middleware: a shared secret, a bearer token, or a machine client's key.

• Services

  Give logic that is not CRUD a package of its own, with no HTTP in it.

• Background jobs

  Add River with --jobs at new time, or later with g job, and write a worker that runs beside it.

• Configuration and credentials

  The environment variables, the encrypted settings file, and what staging means here.

• Testing and CI

  Where tests live, what bin/ci runs, and what doctor checks before either does.

• Deploying

  One Docker image, every role, shipped with Kamal 2 to staging and production.

• Conventions and agents

  The six rules every generated app keeps, and why the layout is Rails-shaped on purpose.

• From Rails

  A dictionary: what each Rails thing is called here, where it lives, and what has no equivalent.

• Command reference

  Every bogie command, every generator and every make target, in one place.