templates

{{- if .Logo.URL }} {{- end }}

{{ .Definition.Project.Title }}

{{ .Definition.Project.Description }}

{{- if .DomainLinks }}

{{ .DomainLinks }}

{{ .Definition.Project.Title }}

{{ if .Content -}} {{ .Content }} {{- end }}

{{ .Definition.Project.Description }}

Built with WebKit {{ .Definition.WebkitVersion }}.

This repository contains {{ len .Definition.Apps }} application{{ if ne (len .Definition.Apps) 1 }}s{{ end }}{{ if .Definition.Resources }} and {{ len .Definition.Resources }} resource{{ if ne (len .Definition.Resources) 1 }}s{{ end }}{{ end }}.

{{- if .MonitorBadges }}

Status

Uptime monitors for the application. Visit the [status page]({{ .StatusPageURL }}) for more details. {{- if .DashboardURL }}

View all monitors on the [dashboard]({{ .DashboardURL }}). {{- end }}

Apps

{{- range .Definition.Apps }}

{{ .Title }}

{{ if eq .Type "payload" }} {{- else if eq .Type "svelte-kit" }} {{- end }}

Type: {{ .Type }}{{ if .Build.Port }} | Port: {{ .Build.Port }}{{ end }}{{ if .PrimaryDomain }} | Domain: {{ .PrimaryDomain }}{{ end }}

{{ .Description }}

{{- if .OrderedCommands }}

Commands:

{{- $tools := .InstallCommands }} {{- if $tools }}

Tools: {{- range $tools }}

• {{ . }} {{- end }} {{- end }}

{{- if .Infra.Provider }}

Infrastructure:

• Provider: {{ .Infra.Provider }}
• Type: {{ .Infra.Type }} {{- range $key, $value := .Infra.Config }}
• {{ prettyConfigKey $key }}: {{ $value }} {{- end }} {{- end }} {{- end }}

{{- if .Definition.Resources }}

Resources

{{- range .Definition.Resources }}

{{ .Title }}

{{ if eq .Type "postgres" }} {{- else if eq .Type "s3" }} {{- else if eq .Type "sqlite" }} {{- end }}

Type: {{ .Type }} | Provider: {{ .Provider }} | Backups: {{ if .Backup.Enabled }}Enabled{{ else }}Disabled{{ end }} {{- if .Description }}

{{ .Description }} {{- end }}

Configuration:

Available Outputs: {{- range .Type.Documentation }}

• {{ .Name }} - {{ .Description }} {{- end }} {{- end }} {{- end }}

Development

Prerequisites

{{- if .Definition.ContainsGo }}

• Go (latest) {{- end }} {{- if .Definition.ContainsJS }}
• Node.js and pnpm {{- end }}
• Docker and Docker Compose
• WebKit CLI

Getting Started

1. Clone the repository:

   git clone https://github.com/{{ .Definition.Project.Repo.Owner }}/{{ .Definition.Project.Repo.Name }}.git
   cd {{ .Definition.Project.Repo.Name }}
   

2. Install dependencies:

   pnpm install
   

3. Start development:

   pnpm dev
   

4. Access applications: {{- range .Definition.Apps }} {{- if gt .Build.Port 0 }}

   • {{ .Title }}: http://localhost:{{ .Build.Port }} {{- end }} {{- end }}

Deployment

Deployment is managed by WebKit using:

• Infrastructure: Terraform
• CI/CD: GitHub Actions
• Environments: Development, Production

{{- if .ProviderGroups }}

Hosting Providers: {{- range $provider, $items := .ProviderGroups }}

• {{ $provider }}: {{ $items }} {{- end }} {{- end }}

License

Code Copyright {{ .CurrentYear }} {{ .Definition.Project.Repo.Owner }}. Code released under the BSD-3 Clause.

Built with WebKit