cachethq/core

Cachet core package.

dev-main 2024-10-31 16:31 UTC

README

Build Status GitHub Sponsors Total Downloads Latest Stable Version License

Introduction

This package provides the core functionality of Cachet and may be installed into existing Laravel applications. Cachet 3.x will ship as a standalone Laravel application that requires this package.

Project Status

Cachet 3.x is currently in development and is not yet completely ready for production use. We are actively working on the project and will provide updates as we progress.

  • Incident Management
  • Incident Updates
  • Scheduled Maintenance
  • Scheduled Maintenance Updates
  • Components
  • Metrics
    • API and dashboard are working.
    • Frontend is in progress.
  • Subscribers
  • API
    • Complete but may need some tweaks as we progress.
  • Webhooks
  • Dashboard
  • Localization
  • Status Page Customization

Stack

Cachet is built on:

Development

  1. Clone this repository.
  2. Run the following commands from within the core directory:
    npm install
    composer update
    composer dev
  3. Develop Cachet.

Note

HMR is not enabled. Manual refreshes are needed to view changes.

Dashboard Credentials

When running Cachet via the composer dev command, Workbench will seed a user that you can use to log in to the dashboard. Login to the account at /dashboard and use credentials:

  • Email: test@test.com
  • Password: test123

Sponsors

Jump24 Dreamtilt Xyphen-IT

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

License

Cachet Core is open-sourced software licensed under the MIT license.

Trademarks

Copyright (c) 2023-present Alt Three Services Limited. The Cachet name and logo are trademarks of Alt Three Services Limited. Please see our trademark guidelines for info on acceptable usage.

Community

Have questions, comments or feedback? Start a discussion. For the latest news and release notes, visit cachethq.io.

Contributors