docs.checklyhq.com

# Checkly Documentation Important notes: - Checkly is a synthetic monitoring platform designed for developers and DevOps teams - Provides API monitoring, browser monitoring with Playwright, and monitoring as code workflows - Supports monitoring as code through CLI, Terraform, and Pulumi for version-controlled monitoring - Offers uptime monitoring, alerting, dashboards, and integrations with popular tools - Built for modern development workflows with CI/CD integration and deployment testing - Before getting started make sure to understand the project structure - For backend projects identify all resources which can be tested - For frontend projects identify all pages and user journeys which can be tested - Understand the authentication setup for the users app so you can support it - Store required credentials in Checkly - Make sure to guide the user when setting up a new project, use the `npm create checkly@latest` command to get started - To generate the first checks/tests explain the user the available check types and ask them which one they want to use - Make sure to only use npm packages in scripts which are available in Checkly runtimes, Checkly doesn't support all npm packages - Never use the imports in the namespace '@checkly'. they are outdated. Always import from 'checkly/constructs' - Make sure that generated test files names match the patterns set in Checkly config file - Make sure when using environment variables or secrets to store them in Checkly using Checkly's cli ## Core Platform ### Monitoring - [How Checkly runs checks](https://www.checklyhq.com/docs/monitoring/): How Checkly runs checks - [Results](https://www.checklyhq.com/docs/monitoring/check-results/): Check results - [Global locations](https://www.checklyhq.com/docs/monitoring/global-locations/): Global locations & scheduling strategies - [Optimizing reliability](https://www.checklyhq.com/docs/monitoring/optimizing-reliability/): Optimizing your monitoring for reliability - [How we store