PHPackages imonroe/coldreader - 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. imonroe/coldreader ArchivedProject[Utility & Helpers](/categories/utility) imonroe/coldreader ================== A personal information database, note-taking app, and more. 2.2.2(8y ago)1361[2 issues](https://github.com/imonroe/coldreader/issues)[56 PRs](https://github.com/imonroe/coldreader/pulls)GPL-3.0-or-laterPHPPHP ^7.1.3 Since Aug 17Pushed 3y ago2 watchersCompare [ Source](https://github.com/imonroe/coldreader)[ Packagist](https://packagist.org/packages/imonroe/coldreader)[ RSS](/packages/imonroe-coldreader/feed)WikiDiscussions master Synced 2w ago READMEChangelog (3)Dependencies (17)Versions (11)Used By (0) Coldreader ========== [](#coldreader) Coldreader is a casual, personal databasing system. It may be helpful to think of it as something half-way between an mindmap and a private wiki. I use it in place of Evernote, as a personal information management tool. Out of the box, it may seem a little trivial, but once you start building it out with your own custom Aspects, you'll find that there's really no other tool like it. It makes no assumptions about what kind of information you want to keep track. In Coldreader, there are essentially two kinds of things: Subjects, and Aspects. A Subject can contain an arbitrary number of Aspects. Aspects are like a single piece of content. That may be text, an image, an API result, and so forth. By itself, a basic Aspect just stores its information as text in the database. But you can extend simple aspects with a little bit of code so that they can behave however you like. By modifying the boilerplate with your own logic, you can retrieve API results, perform a calculation, whatever you like. For more information, see Developing Custom Aspects below. Coldreader is primarily aimed at people who are comfortable with basic web development using PHP and Javascript. It's built using Laravel 5.6, Bootstrap 3, and Vue.js. This is the open-source version. It is configured to support a single user, and includes some tools to make it easy to customize the system for your own uses. Use cases: - Project management system - Personal CRM system - Build custom dashboards to track subjects of interest - Manage your collection of media - Track your notes and references as you research new things - Create a knowledge base of problems you have previously solved - Keep a library of your favorite recipes - API test bed - quickly add new features by implementing an API and using your existing data - Organize your data however you like Install ------- [](#install) Coldreader is based on [Laravel 5.6](https://laravel.com/), and requires a server that is capable of serving a Laravel project, or any machine with Docker and Docker Compose installed. For specific information about server requirements, [see the Laravel docs.](https://laravel.com/docs/5.6#server-requirements) The Homestead vagrant box works just fine with Coldreader, and you can try it out in your local environment with no risk. For more information about using Laravel Homestead, [check out their fantasic documentation.](https://laravel.com/docs/5.6/homestead) ### Via docker-compose [](#via-docker-compose) By far, the easiest way to set up Coldreader on your local machine for development is to use the `docker-compose` file. Naturally this requires Docker to be set up on the machine upon which you wish to run the software. - Clone the repo to a convenient location. - `cd` into the directory where you cloned the repo. - Edit the `.env` file to suit your preferences. - Run `docker-compose up`. That will build the application stack. - It may take quite some time to build the stack the first time you run `docker-compose up`. This is normal. Subsequent builds will be faster. - The application will be available at: . You can access Adminer to manipulate the database at: - Need to run `artisan` commands? Need to rebuild the assets with webpack? You can do so within the docker container using the normal methods. To get a `bash` shell: - On a Windows system, just run `larabash.bat` - On Macs and \*nix-like systems, just run `docker-compose exec laravel bash` ### Installing additional add-ons [](#installing-additional-add-ons) One of the nice things about Coldreader is that it's easy to create new Aspect Types and Search Providers to accomodate different kinds of data, and different ways of displaying it. There are some Aspect Types already available to try. To install Coldreader add-on packages, use composer within the application container: ``` $ composer require / $ composer update ``` Some add-on packages may require additional configuration. Consult the package repo for details for any individual add-on. #### Add-ons currently available: [](#add-ons-currently-available) - COMING SOON! Developing with Coldreader -------------------------- [](#developing-with-coldreader) For instructions and examples for how to get started developing with Coldreader, [please see the wiki.](https://github.com/imonroe/coldreader/wiki) Change log ---------- [](#change-log) Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently. Testing ------- [](#testing) From within `bash` in the application container: ``` $ cd application $ composer test ``` Contributing ------------ [](#contributing) Please see [CONTRIBUTING](CONTRIBUTING.md) and [CONDUCT](CONDUCT.md) for details. Security -------- [](#security) If you discover any security related issues, please email instead of using the issue tracker. Credits ------- [](#credits) - [Ian Monroe](https://github.com/imonroe) - [All Contributors](../../contributors) License ------- [](#license) GPL V3. Please see [License File](LICENSE.md) for more information. ### Health Score 24 — LowBetter than 31% of packages Maintenance0 Infrequent updates — may be unmaintained Popularity10 Limited adoption so far Community9 Small or concentrated contributor base Maturity64 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 ~34 days Recently: every ~68 days Total 10 Last Release 2936d ago Major Versions 1.0.x-dev → 2.0.22017-08-17 PHP version history (3 changes)2.0.2PHP >=5.6.4 2.0.6PHP >=7.0 2.1.0.x-devPHP ^7.1.3 ### Community Maintainers ![](https://www.gravatar.com/avatar/afb5927cefc4188816f1829f1c3332f83a18a8badcf42db1befb2d08df3a9cb5?d=identicon)[imonroe](/maintainers/imonroe) --- Top Contributors [![imonroe](https://avatars.githubusercontent.com/u/1263892?v=4)](https://github.com/imonroe "imonroe (136 commits)") ### Code Quality TestsPHPUnit ### Embed Badge ![Health badge](/badges/imonroe-coldreader/health.svg) ``` [![Health](https://phpackages.com/badges/imonroe-coldreader/health.svg)](https://phpackages.com/packages/imonroe-coldreader) ``` ### Alternatives [unopim/unopim UnoPim Laravel PIM 10.5k2.2k](/packages/unopim-unopim)[statamic/cms The Statamic CMS Core Package 4.8k3.5M929](/packages/statamic-cms)[grumpydictator/firefly-iii Firefly III: a personal finances manager. 23.8k69.4k](/packages/grumpydictator-firefly-iii)[nasirkhan/laravel-starter A CMS like modular Laravel starter project. 1.4k2.7k](/packages/nasirkhan-laravel-starter)[tempest/framework The PHP framework that gets out of your way. 2.2k31.1k12](/packages/tempest-framework)[helsingborg-stad/municipio A bootstrap theme for creating municipality sites. 4028.3k10](/packages/helsingborg-stad-municipio) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)