Skip to content

Reference manual

Here's a comprehensive list of features and settings included in Trek.

Generators

Installer

sh
rails g trek:install
# or (soon)
trek install

Trek provides a install generator, that will:

  • install all dependencies
  • create the User model and include Trek's concerns
  • create the Page, PagePath and PageVersion model and include Trek's concerns
  • create the Fragment model and include Trek's concerns
  • create the relevant policies
  • generate and run the relevant migrations

Admin user

sh
rails g trek:admin:user
# or (soon)
trek admin:user

Scaffold

sh
rails g trek:scaffold Book title intro

Akin to Rails', Trek's scaffold generates, with a single command:

  • the Book model and migration (calling the Rails model generator behind the scenes)

Models

Controllers

Forms

Formatters

Policies

Uploaders

Front-end

Components

Icons