Encore Templates
Templates to help you build backend applications with Encore.
This repo contains two types of templates:
- Starters: Runnable Encore applications for others to use as is, or take inspiration from.
- Bits: Re-usable code samples to solve common development patterns or integrate Encore applications with third-party APIs and services.
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
| Name | Description | Primitives |
|---|---|---|
| hello-world | REST API Starter | APIs |
| sql-database | PostgreSQL database Starter | APIs, SQL Database |
| ai-chat | LLM chat room application which let's you create and chat with personalized bots. Integrates with OpenAI, Gemini, Slack and Discord | Microservices, APIs, SQL Database, Pub/Sub, Cron Jobs, Frontend, External Requests, Configs |
| assembly-ai | AssemblyAI Starter - Conversational Intelligence app that lets you upload and transcribe voice data. | APIs, SQL Database, Frontend, External Requests, Configs |
| slack-bot | Slack Bot Starter | APIs, Webhooks |
| trello-clone | Microservices Starter (Trello Clone) | Microservices, APIs, SQL Database |
| uptime | Event-Driven Architecture Starter (Uptime Monitor) | Microservices, SQL Databases, Pub/Sub, Cron Jobs |
| graphql | GraphQL Server Starter | APIs, SQL Database, GraphQL |
| url-shortener | Basic url shortener | APIs, SQL Database |
| sqlc-database | Simple sqlc implementation | APIs, SQL Database |
| next-starter | Next.js + Encore Web App Starter | APIs, Auth, Frontend |
| next-auth0-starter | Next.js + Auth0 + Encore Web App Starter | Microservices, APIs, Auth, Frontend |
| react-starter | React + Encore Web App Starter | APIs, Auth, Frontend |
| booking-system | Appointment Booking System Starter using data scrubbing and sqlc | Microservices, APIs, Auth, SQL Database, Frontend |
| meeting-notes | Meeting Notes App deployed to GitHub Pages | APIs, SQL Database, External Requests |
| auth0 | Auth0 Authentication + React + Encore Example | APIs, Auth, Frontend |
| auth0-react-sdk | Auth0 React SDK Authentication + Encore Example | APIs, Auth, Frontend |
| clerk | Clerk React SDK Authentication + Encore Example | APIs, Auth, Frontend |
| firebase-auth | Firebase Authentication + Encore Example | APIs, Auth, Frontend |
| Name | Description | Primitives |
|---|---|---|
| ts/hello-world | REST API Starter | APIs |
| ts/ai-chat | LLM chat application which let's you create and chat with personalized bots. Integrates with OpenAI, Anthropic and Slack | Microservices, APIs, SQL Database, Pub/Sub, External Requests, Configs |
| ts/streaming | Examples of the different WebSocket Streaming APIs | Streaming API, Static Endpoint, Frontend |
| ts/graphql | Apollo GraphQL Server Starter | APIs, GraphQL |
| ts/streaming-chat | Simple Chat app using the Streaming API to create a WebSocket stream | Streaming API, Static Endpoint, Frontend |
| ts/simple-event-driven | Simple Event-Driven Application | Microservices, SQL Database, Pub/Sub, Secrets |
| ts/uptime | Event-Driven Architecture Starter (Uptime Monitor) | Microservices, SQL Databases, Pub/Sub, Cron Jobs |
| ts/gpt-functions | ChatGPT Functions with Encore Example | APIs |
| ts/url-shortener | Basic url shortener | APIs, SQL Database |
| ts/nestjs | Encore + NestJS Example | APIs, SQL Database, Auth |
| https://github.com/encoredev/nextjs-starter/ † | Encore + Next.js Web App Starter | Microservices, APIs, Frontend |
| ts/slack-bot | Slack Bot Starter | APIs, Raw Endpoint |
| ts/auth0-react-sdk | Auth0 React SDK Authentication + Encore Example | APIs, Auth, Frontend |
| ts/clerk | Clerk React SDK Authentication + Encore Example | APIs, Auth, Frontend |
| ts/supabase | Supabase Authentication + Encore Example | APIs, Auth, Frontend |
| ts/elevenlabs | ElevenLabs AI Speech SDK + Encore Example | APIs, Raw Endpoints, Frontend |
| ts/sequelize | Encore + Sequelize TypeScript Example | APIs, SQL Database |
| ts/expressjs-migration | Express.js migration guide examples | APIs, Raw Endpoints, Auth, Databases |
| ts/file-upload | Upload files from frontend example | Raw Endpoints |
| ts/static-files | Serving static files example | Static Endpoints |
| ts/template-engine | Using a templating engine | Raw Endpoints, Static Endpoints |
† = Cannot be installed using encore app create --example, create an empty app and clone the repo instead.
Each sub-folder in this repo contains a runnable Starter application.
Use encore app create [app-name] --example=[folder-name] to
create your own app based on the example.
For example, to create an app based on hello-world:
$ encore app create my-app --example=hello-world
Successfully created app my-app.
$ cd my-app
$ encore run
Running on http://localhost:4000
8:00AM INF registered endpoint endpoint=There service=helloThe bits sub-folder contains reusable code samples that can be copied directly into your own application.
| Name | Description | Primitives | Requirements |
|---|---|---|---|
| elevenlabs | Getting text to speech from ElevenLabs generative voice AI | APIs, Secrets | ElevenLabs API key |
| pexels | Searching and retrieving photos and videos from Pexels | APIs, Secrets | Pexels API key |
| sendgrid | Asynchronous sending emails via SendGrid | APIs, Secrets, Pub/Sub | SendGrid API key |
Contribute a template by submitting a Pull Request to
the Open Source Examples Repo: https://github.com/encoredev/examples
Follow these steps to submit a Starter:
- Fork the repo.
- 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> - Include a
README.mdwith 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.
Follow these steps to submit your Bits:
- Fork the repo.
- Create a new folder inside the
bitsfolder in the repo and place your template inside it. Use a short folder name as your template will soon be installable via the CLI. - Include a
README.mdwith 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.
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.