PHPackages                             miklcct/journey\_recorder - 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. [Database & ORM](/categories/database)
4. /
5. miklcct/journey\_recorder

ActiveLibrary[Database & ORM](/categories/database)

miklcct/journey\_recorder
=========================

Record your public transport journeys into a database

1.7.0(11mo ago)040[2 issues](https://github.com/miklcct/journey_recorder/issues)AGPL-3.0-or-laterPHPPHP ^8.1

Since Mar 2Pushed 11mo ago1 watchersCompare

[ Source](https://github.com/miklcct/journey_recorder)[ Packagist](https://packagist.org/packages/miklcct/journey_recorder)[ RSS](/packages/miklcct-journey-recorder/feed)WikiDiscussions main Synced 4d ago

READMEChangelogDependencies (6)Versions (26)Used By (0)

Journey Recorder
================

[](#journey-recorder)

This application helps you to record your public transport journeys while on the go.

System requirements
-------------------

[](#system-requirements)

- PHP: ^8.1 (with mysqli extension)
- Composer
- Yarn

Installation
------------

[](#installation)

### As a standalone application

[](#as-a-standalone-application)

1. Run `composer create-project miklcct/journey_recorder`
2. Load the schema provided in `resource/base.sql` and all migrations in `resource/migrations/up` into a MariaDB database.
3. Configure your web server to have `public` as the document root, or link a subfolder under the document root to the `public` folder.

### As a library used in a PHP application

[](#as-a-library-used-in-a-php-application)

1. Run `composer require miklcct/journey_recorder` in your PHP application.
2. Load the schema provided in `resource/base.sql` and all migrations in `resource/migrations/up` into a MariaDB database.
3. Provide your implementation of `JourneyResponseFactoryInterface` such that the UI fits into your website. The `JourneyView` class and `journey_main.xhtml.php` template is a good starting point. If you are using them, link `scripts/journey.js` and `stylesheets/journey.css` into your public folder and pass the web path into the `JourneyView` constructor.
4. If you want the offline functionality, link `journey_service_worker.js` into your public folder as well and register it in your script. The provided `scripts/journey.js` does that, in this case it must be put in the root of the public folder.
5. Add a route in your website to have `JourneyApplication`, which is PSR-15 compliant, as the controller.

Usage
-----

[](#usage)

This application is for recording journeys only. It doesn't provide any interfaces for later retrieval (except the latest one) or analysis tools.

It allows you to enter the information for a public transport journey, including the distance, fare and tickets. It supports multiple tickets and split tickets. If a distance is not provided, it will attempt to fill it from a previous identical journey.

The ticket list is populated from the previous submission. If no tickets are shown, use the "Get the last inserted journey" button to load them.

The "push into queue" and "pop from queue" buttons are provided to save the form and load it later when it's not ready for submission, or in situations when you are temporarily lacking internet access (such as in the Tube).

If the browser supports service workers and the default script is used, the script registers a service worker to cache resources needed for the application, such that it is usable while offline. Also, the submit buttons are disabled while offline.

Database migrations
-------------------

[](#database-migrations)

The migration files are organised in the structure required by `byjg/migration` package. However, the use of the library is not necessary. If you want to use it for your database(s), install the CLI interface by running `composer global require byjg/migration-cli`.

Defects
-------

[](#defects)

Some database column names may be misleading. However, to prevent compatibility issues, they will only be fixed in the next major release:

- The database should be unit agnostic on distance but some columns assume the use of km as the unit of distance:

    - `tickets view`.`price per km`
    - `journeys fare`.`fare per km`

    These should all mean per distance instead of per km to allow the use of alternative distance units.
- `tickets view`.`distance travelled` means person-distance travelled, while `tickets view`.`segments travelled` means segments travelled regardless of number of people using that ticket
- `advance` does not adequately cover all pre-purchase requirement:

    - Quota-controlled tickets are sold against a quota. They are not guaranteed to be available.
        - A ticket is quota-controlled if it must be bought against a specific service and not valid on any others without changing it, even if the price never changes, as walk-up travel is not guaranteed.
    - Advance purchase non-quota-controlled tickets are always available before a specified deadline, but not immediately before travel.
    - Walk up tickets are guaranteed to be available at the time of travel.
- `boarding time stamp` and `alighting time stamp` represent the time in UTC time zone. These are no longer `timestamp` columns since version 1.6.0 because of time zone issues when trying to calculate local time in a stored column.

Demos
-----

[](#demos)

The following demos can be used for testing, but due to privacy concern (data will go through servers under author's control) they are not suggested being used in production.

- [Standalone site](https://journey.miklcct.com/)
- [Part of another website](https://miklcct.com/journey)

###  Health Score

37

—

LowBetter than 83% of packages

Maintenance52

Moderate activity, may be stable

Popularity8

Limited adoption so far

Community7

Small or concentrated contributor base

Maturity68

Established project with proven stability

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~49 days

Recently: every ~142 days

Total

25

Last Release

339d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/10e7afba9bdfe9e5cb8c200f1552d8e1fc5f3e0a843fb19306858c8aa8e19017?d=identicon)[miklcct](/maintainers/miklcct)

---

Top Contributors

[![miklcct](https://avatars.githubusercontent.com/u/2827264?v=4)](https://github.com/miklcct "miklcct (64 commits)")

### Embed Badge

![Health badge](/badges/miklcct-journey-recorder/health.svg)

```
[![Health](https://phpackages.com/badges/miklcct-journey-recorder/health.svg)](https://phpackages.com/packages/miklcct-journey-recorder)
```

###  Alternatives

[doctrine/orm

Object-Relational-Mapper for PHP

10.2k285.3M6.2k](/packages/doctrine-orm)[mongodb/mongodb

MongoDB driver library

1.6k64.0M546](/packages/mongodb-mongodb)[worksome/foggy

Foggy is a tool for making database dumps with some data removed/changed.

26571.7k1](/packages/worksome-foggy)[orchestra/database

Database Component for Orchestra Platform

201.4M578](/packages/orchestra-database)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)