Giter VIP home page Giter VIP logo

examples's Introduction

encore icon

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 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

TypeScript

Name Description Primitives
ts/hello-world REST API Starter APIs
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/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:

$ 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 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 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.

examples's People

Contributors

bogdaaamn avatar domblack avatar eandre avatar eitamal avatar ekerfelt avatar fstien avatar marcuskohlberg avatar marcusolsson avatar matbur avatar shixzie avatar simon-johansson avatar woodroow avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar

examples's Issues

Build a Go example app using Encore + Twitter API

We'd love to see a new Encore application template using Go, Encore, and the Twitter API. To create a new Encore application, run brew install encoredev/tap/encore (see the Install Guide) and then run encore auth login and encore app create to build a new application.

When building the application, feel free to either submit it as a directory within this repository or create a new repository.

Additional tasks

For extra bonus points: we'd love to see you submit a walkthrough video, or a tutorial.

Build a Go example app using Encore + Stripe Checkout API

We'd love to see a new Encore application template using Go, Encore, and the Stripe Checkout API. To create a new Encore application, run brew install encoredev/tap/encore (see the Install Guide) and then run encore auth login and encore app create to build a new application.

When building the application, feel free to either submit it as a directory within this repository or create a new repository.

Additional tasks

For extra bonus points: we'd love to see you submit a walkthrough video, or a tutorial.

Build a Go example app using Encore + GitHub API

We'd love to see a new Encore application template using Go, Encore, and OAuth. To create a new Encore application, run brew install encoredev/tap/encore (see the Install Guide) and then run encore auth login and encore app create to build a new application.

When building the application, feel free to either submit it as a directory within this repository or create a new repository.

Additional tasks

For extra bonus points: we'd love to see you submit a walkthrough video, or a tutorial.

Build a Go example app using Encore + OAuth

We'd love to see a new Encore application template using Go, Encore, and OAuth. To create a new Encore application, run brew install encoredev/tap/encore (see the Install Guide) and then run encore auth login and encore app create to build a new application.

When building the application, feel free to either submit it as a directory within this repository or create a new repository.

Additional tasks

For extra bonus points: we'd love to see you submit a walkthrough video, or a tutorial.

The Uptime monitoring tutorial's frontend is not working

This tutorial:
https://encore.dev/docs/tutorials/uptime

isn't fully finished as the frontend is not working when following the instructions.

The issues are that there is a missing monitor/status.go file, not explained in the tutorial. Also, missing instructions on how to then regenerate the frontend client to use your backend.

The generated file, which is given out of the box, won't work for your deployment because it points to a different app, which is not currently deployed, ie it's hardcoded https://${name}-uptime-7chi.encore.app

Build a Microsoft Teams bot in Go using Encore

We'd love to see a new Encore application template using Go, Encore, and Microsoft Teams. To create a new Encore application, run brew install encoredev/tap/encore (see the Install Guide) and then run encore auth login and encore app create to build a new application.

When building the application, feel free to either submit it as a directory within this repository or create a new repository.

Additional tasks

For extra bonus points: we'd love to see you submit a walkthrough video, or a tutorial.

Build a Go example app using Encore + calling APIs using gRPC

We'd love to see a new Encore application template using Go, Encore, and communicating to an external gRPC API. To create a new Encore application, run brew install encoredev/tap/encore (see the Install Guide) and then run encore auth login and encore app create to build a new application.

When building the application, feel free to either submit it as a directory within this repository or create a new repository.

Additional tasks

For extra bonus points: we'd love to see you submit a walkthrough video, or a tutorial.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.