How to develop

If you wish to further customize your UptimeFlare or contribute new features to this repository (by submitting a pull request), this documentation provides a brief overview of the development process.

UptimeFlare consists of two components: a Cloudflare Pages project responsible for displaying the frontend status page, and a Cloudflare Workers project that performs actual status checks triggered by a CRON job. Both share state through a common Cloudflare KV (key-value store).

To start your development, I recommend you still follow the standard setup procedure. This will trigger a GitHub Actions workflow that uses Terraform to deploy all necessary resources, eliminating the need for cumbersome and error-prone manual steps.

After deployment completes, you can git clone your own repository, modify the code, commit, and push to your repository. Actions will run again and deploy your changes.

If you need to make multiple modifications and find the full deployment process for Actions too slow, you can run the compilation and wrangler deploy commands mentioned in Actions locally to speed up the deployment process. Depending on whether you modified the Workers or Pages part, you only need to deploy the corresponding part you changed.