# Project Structure

#### 📜  CheckCle Project Root

```
Project-structure/
├── .github/
├── application/
├── docker/
├── docs/
├── scripts/
├── server/
├── .gitignore
├── CODE_OF_CONDUCT.md
├── CONTRIBUTING.md
├── LICENSE.md
├── README.md
├── SECURITY.md
└── docker-compose.yml
```

#### 📁 Key Folders & Files

* **.github/**\
  Contains GitHub-specific configurations and workflows (e.g., Template, CI/CD pipelines).
* **application/**\
  Likely houses the main frontend/Tailwind-based application layer.
* **docker/**\
  Contains Docker configuration scripts or `Docker compose` setups for containerized deployment.
* **docs/**\
  Documentation for the project—including split README, CONTRIBUTING into different language. installation guides, API docs, and user manuals.
* **scripts/**\
  Utility scripts for project management—such as build, install, deployment, or agent setup tasks.
* **server/**\
  Backend Go services (Core operations check service, handling uptime, SSL monitoring, endpoints, core services and more).
* **docker-compose.yml**\
  Defines multi-container setup—frontend UI, backend service, database, agents 
* **README.md**\
  Main project overview, features, and quick-start instructions [github.com](https://github.com/operacle/checkcle/releases).
* **LICENSE.md & CODE\_OF\_CONDUCT.md & SECURITY.md & CONTRIBUTING.md**\
  Standard community files defining usage license, contribution rules, security policy, and code-of-conduct.

#### 🧩 Architecture Highlights

* **Frontend (TypeScript/Vite)** in `application/`
* **Backend (in Go)** in `server/` covering monitoring services, distributed and server agents
* **Dockerized Deployment** via `docker/` folder and `docker-compose.yml`
* **Comprehensive Docs** and automated pipelines via `.github/` and `scripts`


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.checkcle.io/getting-started/project-structure.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.