PHPackages                             bozboz/jam - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. bozboz/jam

AbandonedLibrary

bozboz/jam
==========

v1.22.6(3y ago)03.4k1PHP

Since Apr 20Pushed 3y ago4 watchersCompare

[ Source](https://github.com/bozboz/jam)[ Packagist](https://packagist.org/packages/bozboz/jam)[ RSS](/packages/bozboz-jam/feed)WikiDiscussions master Synced 1mo ago

READMEChangelog (3)Dependencies (2)Versions (12)Used By (1)

Jam Package
===========

[](#jam-package)

Contents
--------

[](#contents)

- [1. Installation](#1-installation)
- [2. Data Setup](#2-data-setup)
    - [2.1. Types](#21-types)
    - [2.2. Templates](#22-templates)
        - [2.2.1. Migrating Templates](#221-migrating-templates)
    - [2.3. Fields](#23-fields)
    - [2.4. Entities](#24-entities)
    - [2.5. Revisions](#25-revisions)
- [3. Usage](#3-usage)
    - [3.1. Catchall Route](#31-catchall-route)
    - [3.2. EntityRepository](#32-entity-repository)
    - [3.3. Listings & Other Data](#33-listings-other-data)
    - [3.4. Canonical Paths](#34-canonical-paths)
    - [3.5. Value Retrieval](#35-value-retrieval)
- [4. Search Indexing](#4-search-indexing)

---

1. Installation
---------------

[](#1-installation)

1. Require the package in Composer, by running `composer require bozboz/jam`
2. Add `Bozboz\Jam\Providers\JamServiceProvider::class` to the providers array config/app.php - NOTE: This must be above the RouteServiceProvider or routes will not sequence correctly. Add it to the pre-existing bozboz serviceproviders.
3. Run `php artisan vendor:publish && php artisan migrate`
4. Jump to [3. Usage](#3-usage) for the default catchall route

---

2. Data Setup
-------------

[](#2-data-setup)

### 2.1. Types

[](#21-types)

Entity types (a.k.a Types) are the top level of the jam schema. They can essentially be thought of as models, or a logical grouping of models (todo:clarify), since the templates actually have the fields. Types are registered in an app's service providers, eg

```