Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.cachethq.io/llms.txt

Use this file to discover all available pages before exploring further.

Cachet is built using the Laravel PHP framework, and is a great way to get started with Laravel development. If you’re new to Laravel, you can learn more about it on the Laravel website.
1

Install Laravel Herd

We recommend installing Laravel Herd, a free local development environment for PHP Laravel. It’s a great way to get started with Laravel development and is the perfect environment for contributing to Cachet.Herd will install PHP, Composer and NPM for you. You can manage each version through the Herd UI.
2

Clone Cachet's Core

The majority of development is done in the cachethq/core repository. You’ll need to clone this repository to your local machine.
git clone [email protected]:cachethq/core.git cachet-core
We recommend cloning the repository into a directory named cachet-core to keep things organized.
3

Install Dependencies

Once you’ve cloned the repository, you’ll need to install the dependencies.
cd cachet-core
composer install
npm install
4

Running Cachet

With dependencies installed, you can now run Cachet using SQLite.
composer start
Your local Cachet instance will now be accessible on 127.0.0.1:8000. The terminal will include output for:
  • Vite assets
  • Laravel logs
  • Laravel queue
You can stop the server at any time by pressing Ctrl + C.

​
Video