examples

Encore Templates
Templates to help you build backend applications with Encore.

Template types

This repo contains two types of templates:

• Starters: Runnable Encore applications to use as they are or to take inspiration from.
• Bits: Small re-usable parts solving common development patterns or integrating Encore applications with third-party APIs and services.

Prerequisite: Install Encore

If this is the first time you're using Encore, you first need to install the CLI that runs the local development environment. Use the appropriate command for your system:

• macOS: brew install encoredev/tap/encore
• Linux: curl -L https://encore.dev/install.sh | bash
• Windows: iwr https://encore.dev/install.ps1 | iex

Starters

Create a local app from a template by running:

encore app create [app-name] --example=[folder-name]

E.g. encore app create my-app --example=ts/hello-world

TypeScript starters

Go starters

† = Cannot be installed using encore app create --example, create an empty app and clone the repo instead.

Bits

Go Bits

The bits sub-folder contains reusable code samples that can be copied directly into your own application.

Contribute your templates

Contribute a template by submitting a Pull Request to the Open Source Examples Repo: https://github.com/encoredev/examples

Submitting Starters

Follow these steps to submit a Starter:

1. Fork the repo.
2. Create a new folder in the root directory of the repo, this is where you will place your template. Use a short folder name as your template will be installable via the CLI, like so: encore app create APP-NAME --example=<TEMPLATE_FOLDER_NAME>
3. Include a README.md with instructions for how to use the template. We recommend following this format.

Once your Pull Request has been approved, it may be featured on the Templates page on the Encore website.

Submitting Bits

Follow these steps to submit your Bits:

1. Fork the repo.
2. Create a new folder inside the bits folder in the repo and place your template inside it. Use a short folder name as your template will soon be installable via the CLI.
3. Include a README.md with instructions for how to use the template.

Once your Pull Request has been approved, it may be featured on the Templates page on the Encore website.

Dynamic Encore AppID

In most cases, you should avoid hardcoding an AppID in your template's source code. Instead, use the notation {{ENCORE_APP_ID}}.

When a developer creates an app using the template, {{ENCORE_APP_ID}} will be dymically replaced with their new and unique AppID, meaning they will not need to make any manual code adjustments.