PHPackages                             codymoorhouse/chronicle - 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. [Utility & Helpers](/categories/utility)
4. /
5. codymoorhouse/chronicle

ActiveLibrary[Utility & Helpers](/categories/utility)

codymoorhouse/chronicle
=======================

A note sharing library that lets users interact with eachother using file uploads and comments.

v1.1.2(7y ago)0842ISCVuePHP >=5.5.9

Since Jun 1Pushed 7y ago1 watchersCompare

[ Source](https://github.com/codymoorhouse/chronicle)[ Packagist](https://packagist.org/packages/codymoorhouse/chronicle)[ Docs](https://github.com/codymoorhouse/chronicle)[ RSS](/packages/codymoorhouse-chronicle/feed)WikiDiscussions master Synced today

READMEChangelog (1)Dependencies (3)Versions (11)Used By (0)

Chronicle
=========

[](#chronicle)

```
composer require codymoorhouse/chronicle

```

### Table Of Contents

[](#table-of-contents)

1. [About](#about)
2. [Installation](#installation)
3. [Requirements](#requirements)
4. [Instructions](#instructions)
5. [Usage](#usage)
6. [Properties](#properties)
7. [License](#license)

About
-----

[](#about)

This package is designed for Laravel that lets users interact with eachother using notes that allow for file uploads and comments. Notes are tracked and held in sections and can have multiple files/comments attached.

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

[](#installation)

#### Requirements

[](#requirements)

To use this package, the following requiremenst must be met:

- [Composer](https://getcomposer.org/)
- [Laravel](https://laravel.com/) (5.3+)
- [Carbon](https://carbon.nesbot.com/)

#### NPM Packages

[](#npm-packages)

- [Vuejs](https://vuejs.org/) (v2)
- [Axios](https://github.com/axios/axios)

#### Current Front End Limitations

[](#current-front-end-limitations)

As the package is still being developed, not all features are currently available. For now, it is recommended you disable the features in the database by setting the booleans accordingly on the sections you are using.

- Attachments
- Comments
- Private / Public Differentiation

#### Instructions

[](#instructions)

Once you have succesfully required the package, (v5.3 only) you must register the service provider in your config/app.php file.

```
CodyMoorhouse\Chronicle\ChronicleServiceProvider::class,

```

After you have registered the package you can now publish the associated files. This will publish the config file as well as some default vue components

```
php artisan vendor:publish --provider="CodyMoorhouse\Chronicle\ChronicleServiceProvider"

```

Before you run the migrations, you can look at the `config/chronicle.php` file and update the values and models as needed, or just use the defaults. Then you may run the migration command to set up all the required tables:

```
php artisan migrate

```

Usage
-----

[](#usage)

### Back End

[](#back-end)

To use chronicle you must make a section in the database. To help set up a quick section, you can use this command:

```
php artisan chronicle:section

```

The tag you specified will be used in the front end. You will also need a reference slug for the front end. Think of the reference slug as a 'sub-section' of a section. So basically when you create a section, you can have many notes within the section. However, notes are assigned a reference slug, and that reference slug determines which notes will be shown.

#### Example: You create a chronicle section with the tag 'user-notes'

[](#example-you-create-a-chronicle-section-with-the-tag-user-notes)

Rather than making a new section for each different user, you simply set the ref-slug to be that users id, or some unique slug for that user. Now when a user looks at that section, they will only see notes with the same ref slug. (aka - their id/slug).

### Front End

[](#front-end)

Register chronicle as a component in your vue instance.

```
Vue.component('chronicle', require('./components/chronicle/Chronicle'));
```

Use the component anywhere in your app instance. If you do not pass in a user, chronicle will display as 'read only'.

```

```

#### Properties

[](#properties)

PropertyRequiredTypeDefaultDescriptiontagtrueStringn/aThe tag of the section to showref-slugtrueStringn/aA ref slug for a section, only shows notes with this ref slugload-font-awesomefalseBooleantrueBoolean to toggle auto load of font awesome on or offshow-displayfalseBooleantrueShows the displayshow-inputfalseBooleantrueShows the input / add note buttonshow-pagesfalseBooleantrueTurns off pagination in the title slotshow-titlefalseBooleantrueTurns off title in the title slot (pages will be shown instead)use-font-awesomefalseBooleantrueUse font awesome for buttonsuserfalseObjectnew Object()A logged in user objectLicense
-------

[](#license)

This project is covered under the MIT License. Feel free to use it wherever you like.

###  Health Score

29

—

LowBetter than 60% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity10

Limited adoption so far

Community11

Small or concentrated contributor base

Maturity64

Established project with proven stability

 Bus Factor1

Top contributor holds 92.6% 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 ~33 days

Total

10

Last Release

2601d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/f59254d630b1c12f8a76a7662f073faeae50509b4d3c7ff683bc94154f5cc973?d=identicon)[codymoorhouse](/maintainers/codymoorhouse)

---

Top Contributors

[![codymoorhouse](https://avatars.githubusercontent.com/u/10747839?v=4)](https://github.com/codymoorhouse "codymoorhouse (88 commits)")[![reed-jones](https://avatars.githubusercontent.com/u/11511864?v=4)](https://github.com/reed-jones "reed-jones (7 commits)")

---

Tags

laravelfilescommentsnoteschronicle

### Embed Badge

![Health badge](/badges/codymoorhouse-chronicle/health.svg)

```
[![Health](https://phpackages.com/badges/codymoorhouse-chronicle/health.svg)](https://phpackages.com/packages/codymoorhouse-chronicle)
```

###  Alternatives

[barryvdh/laravel-ide-helper

Laravel IDE Helper, generates correct PHPDocs for all Facade classes, to improve auto-completion.

14.9k123.0M687](/packages/barryvdh-laravel-ide-helper)[psalm/plugin-laravel

Psalm plugin for Laravel

3274.9M308](/packages/psalm-plugin-laravel)[zonneplan/laravel-module-loader

Module loader for Laravel

24118.4k](/packages/zonneplan-laravel-module-loader)[bjuppa/laravel-blog

Add blog functionality to your Laravel project

483.3k2](/packages/bjuppa-laravel-blog)[tizis/lara-comments

Comments system for your Laravel application. Features: can be used to comment on any model, HTML filter customization (HTMLPurifier), API, comment rating, replies, events, auth rules ...

1204.7k](/packages/tizis-lara-comments)

PHPackages © 2026

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