Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/encoredev/examples
Templates for Encore
https://github.com/encoredev/examples
encore golang hacktoberfest
Last synced: about 1 month ago
JSON representation
Templates for Encore
- Host: GitHub
- URL: https://github.com/encoredev/examples
- Owner: encoredev
- License: mit
- Created: 2020-11-07T11:50:16.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2024-08-13T11:59:02.000Z (about 1 month ago)
- Last Synced: 2024-08-14T14:17:19.580Z (about 1 month ago)
- Topics: encore, golang, hacktoberfest
- Language: TypeScript
- Homepage: https://encore.dev/templates
- Size: 19.6 MB
- Stars: 104
- Watchers: 4
- Forks: 32
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Encore Templates
Templates to help you build backend applications with Encore.
## Template types
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.
### Prerequisite: Installing 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
### Go
| Name | Description | Primitives |
|--------------------------------------------|------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------|
| [hello-world](hello-world) | REST API Starter | APIs |
| [sql-database](sql-database) | PostgreSQL database Starter | APIs, SQL Database |
| [ai-chat](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) | AssemblyAI Starter - Conversational Intelligence app that lets you upload and transcribe voice data. | APIs, SQL Database, Frontend, External Requests, Configs |
| [slack-bot](slack-bot) | Slack Bot Starter | APIs, Webhooks |
| [trello-clone](trello-clone) | Microservices Starter (Trello Clone) | Microservices, APIs, SQL Database |
| [uptime](uptime) | Event-Driven Architecture Starter (Uptime Monitor) | Microservices, SQL Databases, Pub/Sub, Cron Jobs |
| [graphql](graphql) | GraphQL Server Starter | APIs, SQL Database, GraphQL |
| [url-shortener](url-shortener) | Basic url shortener | APIs, SQL Database |
| [sqlc-database](sqlc-database) | Simple sqlc implementation | APIs, SQL Database |
| [next-starter](nextjs-starter) | Next.js + Encore Web App Starter | APIs, Auth, Frontend |
| [next-auth0-starter](nextjs-auth0-starter) | Next.js + Auth0 + Encore Web App Starter | Microservices, APIs, Auth, Frontend |
| [react-starter](react-starter) | React + Encore Web App Starter | APIs, Auth, Frontend |
| [booking-system](booking-system) | Appointment Booking System Starter using data scrubbing and sqlc | Microservices, APIs, Auth, SQL Database, Frontend |
| [meeting-notes](meeting-notes) | Meeting Notes App deployed to GitHub Pages | APIs, SQL Database, External Requests |
| [auth0](auth0) | Auth0 Authentication + React + Encore Example | APIs, Auth, Frontend |
| [auth0-react-sdk](auth0-react-sdk) | Auth0 React SDK Authentication + Encore Example | APIs, Auth, Frontend |
| [clerk](clerk) | Clerk React SDK Authentication + Encore Example | APIs, Auth, Frontend |
| [firebase-auth](firebase-auth) | Firebase Authentication + Encore Example | APIs, Auth, Frontend |
### TypeScript
| Name | Description | Primitives |
|------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------|
| [ts/hello-world](ts/hello-world) | REST API Starter | APIs |
| [ts/ai-chat](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/simple-event-driven](ts/simple-event-driven) | Simple Event-Driven Application | Microservices, SQL Database, Pub/Sub, Secrets |
| [ts/uptime](ts/uptime) | Event-Driven Architecture Starter (Uptime Monitor) | Microservices, SQL Databases, Pub/Sub, Cron Jobs |
| [ts/gpt-functions](ts/gpt-functions) | ChatGPT Functions with Encore Example | APIs |
| [ts/url-shortener](ts/url-shortener) | Basic url shortener | APIs, SQL Database |
| [ts/nestjs](ts/nestjs) | Encore + NestJS Example | APIs, SQL Database, Auth |
| [https://github.com/encoredev/nextjs-starter/](nextjs-starter) † | Encore + Next.js Web App Starter | Microservices, APIs, Frontend |
| [ts/slack-bot](ts/slack-bot) | Slack Bot Starter | APIs, Raw Endpoint |
| [ts/auth0-react-sdk](ts/auth0-react-sdk) | Auth0 React SDK Authentication + Encore Example | APIs, Auth, Frontend |
| [ts/clerk](ts/clerk) | Clerk React SDK Authentication + Encore Example | APIs, Auth, Frontend |
| [ts/elevenlabs](ts/elevenlabs) | ElevenLabs AI Speech SDK + Encore Example | APIs, Raw Endpoints, Frontend |
† = Cannot be installed using `encore app create --example`, create an empty app and clone the repo instead.
### Running Starters
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`:
```bash
$ 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=hello
```
## Go Bits
The [bits](bits) sub-folder contains reusable code samples that can be copied directly into your own application.
| Name | Description | Primitives | Requirements |
|-------------------------------|--------------------------------------------------------------------------------------|------------------------|-------------------------------------------------------------------------------------------|
| [elevenlabs](bits/elevenlabs) | Getting text to speech from [ElevenLabs](https://elevenlabs.io/) generative voice AI | APIs, Secrets | [ElevenLabs API key](https://docs.elevenlabs.io/api-reference/quick-start/authentication) |
| [pexels](bits/pexels) | Searching and retrieving photos and videos from [Pexels](https://www.pexels.com/) | APIs, Secrets | [Pexels API key](https://www.pexels.com/api/) |
| [sendgrid](bits/sendgrid) | Asynchronous sending emails via [SendGrid](https://sendgrid.com/) | APIs, Secrets, Pub/Sub | [SendGrid API key](https://docs.sendgrid.com/ui/account-and-settings/api-keys) |
## Contribute your templates
Contribute a template by submitting a Pull Request to
the [Open Source Examples Repo](https://github.com/encoredev/examples): `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=`
3. Include a `README.md` with instructions for how to use the template. We recommend
following [this format](https://github.com/encoredev/examples/blob/8c7e33243f6bfb1b2654839e996e9a924dcd309e/uptime/README.md).
Once your Pull Request has been approved, it may be featured on the [Templates page](/templates) 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](/templates) 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.