https://github.com/j-t-mcc/uptime-backend-api

Website Uptime & Certificate Monitoring API built using Laravel.
https://github.com/j-t-mcc/uptime-backend-api

laravel-application laravel-fortify laravel-sanctum spa

Last synced: 7 days ago
JSON representation

Website Uptime & Certificate Monitoring API built using Laravel.

• Host: GitHub
• URL: https://github.com/j-t-mcc/uptime-backend-api
• Owner: J-T-McC
• License: mit
• Created: 2020-12-06T21:06:04.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2024-06-10T23:04:07.000Z (5 months ago)
• Last Synced: 2024-06-12T05:06:27.950Z (5 months ago)
• Topics: laravel-application, laravel-fortify, laravel-sanctum, spa
• Language: PHP
• Homepage: https://uptime.tysonmccarney.com
• Size: 795 KB
• Stars: 10
• Watchers: 5
• Forks: 6
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Website Uptime & Certificate Monitoring API

[![run-tests](https://github.com/J-T-McC/uptime-backend-api/actions/workflows/run_tests.yml/badge.svg?branch=main)](https://github.com/J-T-McC/uptime-backend-api/actions/workflows/run_tests.yml)

This is a backend API to be paired with [Uptime VueJS](https://github.com/J-T-McC/uptime-frontend-vue) (or what ever else you want to use it for).

This repository implements: 

* [Laravel Fortify](https://laravel.com/docs/11.x/fortify)

* [Laravel Sanctum](https://laravel.com/docs/11.x/sanctum)

* [Spatie Uptime Monitor](https://github.com/spatie/laravel-uptime-monitor)

You can try it out at [https://uptime.tysonmccarney.com/](https://uptime.tysonmccarney.com/)

## Requirements

 

* PHP ^8.3

 

## Installation

```shell script

composer install

php artisan migrate

```

Some things to make note of while populating your .env:

1. Laravel Sanctum requires your SPA and backend to share the same domain. 

   Ex: app.example.com & api.example.com

1. Make sure your SESSION_DOMAIN value allows session cookies to be valid for both domains

```dotenv

APP_URL=https://api.my-domain.com

APP_SPA_URL=https://app.my-domain.com

SANCTUM_STATEFUL_DOMAINS=app.my-domain.com

SESSION_DOMAIN=.my-domain.com

```

To start the uptime and certificate checks, create a cron job to run the scheduler:

```shell script

php artisan schedule:run

```

## Notification Channels

Currently supports:

* Email

* Slack Webhooks

* Discord Webhooks

## License

MIT