encr.dev

module
v1.5.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Aug 11, 2022 License: MPL-2.0

README

Encore - Backend development engine

Encore – Backend Development Engine

Encore is a Backend Development Engine, purpose-built for a flow state developer experience when creating cloud-based backend applications, APIs, and distributed systems using Go. Write your business logic with the Encore Go framework, then let the platform analyze your code to automatically deal with the rest. Start building today and unlock your creative potential with:
  • No endless repetition of boilerplate.

  • No orchestrating and managing cloud services.

  • No reinventing the wheel.

Encore is freely available, based on the Open Source Encore Go Framework.

🏁 Check out the documentation and get started in minutes: encore.dev/docs

⭐ If you find Encore interesting, star this repository to help spread the word.

👋 Have questions? Join the friendly developer community on Slack.

Key features

  • Write a function, get an API: Call any function as an API by adding a single annotation.

  • Microservices without hassle: Define services and API endpoints with a single line of Go code. Create multiple services as easy as creating Go packages.

  • Cloud primitives at your fingertips: Primitives like databases, queues, and scheduled tasks, are native concepts that you express through Go code.

  • Built-in DevOps: Run git push encore to build, test, provision necessary infrastructure, and deploy.

  • One developer experience, unlimited environments: All features work the same in any environment, including local development. Create as many or as few environments as you wish.

  • Infrastructure Provisioning in your own cloud account: Encore understands how your application works, and provisions and manages your cloud infrastructure in your own account. Works with all the major cloud providers, including AWS/Azure/GCP. Encore also offers free build-in cloud hosting for development.

  • Preview Environments: Integrate with GitHub to automatically set up each pull request as a preview environment.

  • Distributed Tracing: Your application is automatically instrumented for excellent observability. Automatically capture information about API calls, goroutines, HTTP requests, database queries, and more.

  • Simple Secrets: The easiest way ever to store and securely use secrets and API keys. Define secrets in your code like any other variable, and Encore takes care of the rest.

  • Automated API documentation: Encore parses your source code to understand the request/response schemas for all your APIs, and automatically generates high-quality, interactive API Documentation for you.

  • Generated Frontend Clients: Automatically generate type-safe, documented clients for your frontends.

Use cases

Encore is designed to help individual developers and teams be incredibly productive, and have more fun, when solving most backend use cases. There are many developers building with Encore, loving the experience when building things like:

  • CRUD backends and REST APIs.
  • Microservices backends for advanced web and mobile apps.
  • Highly performant APIs providing advanced business logic to 3rd parties.
  • And much more...

Getting started

Deploy your first app in minutes by following the Quick Start Guide.

Join the most pioneering developer community

Engineers building with Encore are forward-thinkers who want to focus on creative programming and building great software to solve meaningful problems. It's a friendly place to be, great for exchanging ideas and learnings! Join the conversation on Slack.

We rely on your contributions and feedback to improve Encore for everyone who is using it. Here's how you can contribute:

  • Star and watch this repository to help spread the word and stay up to date.
  • Share your ideas and questions on Slack.
  • Follow Encore on Twitter.
  • Share feedback or ask questions via email.
  • Leave feedback on the Public Roadmap.
  • Send a pull request here on GitHub with your contribution.

Contributing to Encore and building from source

See CONTRIBUTING.md.

Demo video

encore demo video

Visuals

Built-in CI/CD & Infrastructure Provisioning

https://user-images.githubusercontent.com/78424526/169317801-7711b7a2-080d-4da5-bba4-7b8d4104dd68.mp4

Distributed Tracing

https://user-images.githubusercontent.com/78424526/169817256-f3e63f6f-9dd3-4b5a-b72d-be71eef977ed.mp4

Simple Cloud Environments

Simple Cloud Environments

Automated API Documentation

Automated API Documentation

Native Cron Jobs

Native Cron Jobs

Frequently Asked Questions (FAQ)

Who's behind Encore?

Encore was founded by long-time backend engineers from Spotify, Google and Monzo with over 50 years collective experience. We’ve lived through the challenges of building complex distributed systems with thousands of services, and scaling to hundreds of millions of users.

Encore grew out of these experiences and is a solution to the frustrations that came with them: unnecessary crippling complexity and constant repetition of undifferentiated work that suffocates developer’s creativity. With Encore, we want to set developers free to achieve their creative potential.

Who is Encore for?

For individual developers building for the cloud, Encore provides a radically improved experience. With Encore you’re able to stay in the flowstate and experience the joy and creativity of building.

For startup teams who need to build a scalable backend to support the growth of their product, Encore lets them get up and running in the cloud within minutes. It lets them focus on solving for the needs of their users, instead of spending most of their time re-solving the everyday challenges of building distributed systems in the cloud.

For teams in mature organizations that want to focus on innovating and building new features, Encore lets them stop spending time on operations and onboarding new team members. Using Encore for new feature development is easy, just spin up a new backend service in a few minutes.

How is Encore different?

Encore is the only tool that understands what you’re building. The Encore framework, coupled with static analysis, lets Encore deeply understand the application you’re building. This enables the platform to provide a unique developer experience that helps you stay in the flowstate as you’re building.

Unlike many tools that aim to only make cloud deployment easier, Encore is not a cloud hosting provider. With Encore, you can use your own cloud account with all the major cloud providers: AWS/Azure/GCP. This means you’re in control of your data and can maintain your trust relationship with your cloud provider. You can also use Encore's development cloud for free, with pretty generous "fair use" limits.

Why is the framework integrated with cloud hosting?

We've found that to meaningfully improve the developer experience, you have to operate across the full stack. Unless you understand how an application is deployed, there are a large number of things in the development process that you can't simplify. That's why so many other developer tools have such a limited impact. With Encore, we're bravely rethinking the developer experience in a much more significant way.

What if I want to migrate away from Encore?

Encore has been designed to let you go outside of the framework when you want to, and easily drop down in abstraction level when you need to. This means you're not likely to run into any "dead ends".

If you really do want to migrate away, it's relatively easy to do. Because when you build an Encore application, the vast majority of code is just plain Go. So in practice, the amount of code specific to Encore is very small.

Encore has built-in support for ejecting your application as a way of removing the connection to the Encore Platform. Ejecting your app produces a standalone Docker image that can be deployed any where you'd like, and can help facilitating the migration away according to the process above.

Migrating away is also very low risk, since Encore deploys to your own cloud account from the start, so there's never any data to migrate.

Open Source also plays a role. Encore's code generation, compiler, and parser are all open source and can be used however you want. So if you run into something unforeseen down the line, you have free access to the tools you might need.

And since Encore is about building distributed systems, it's quite straightforward to use it in combination with other backends that aren't built with Encore. So if you come across a use case where Encore for some reason doesn't fit, you won't need to tear everything up and start from scratch. You can just build that specific part without Encore.

It's our belief that adopting Encore is a low-risk decision, given it needs no initial investment in foundational work. The ambition is to simply add a lot of value to your every-day development process, from day one.

Directories

Path Synopsis
cli
cmd/git-remote-encore
Command git-remote-encore provides a gitremote helper for interacting with Encore's git hosting without SSH keys, by piggybacking on Encore's auth tokens.
Command git-remote-encore provides a gitremote helper for interacting with Encore's git hosting without SSH keys, by piggybacking on Encore's auth tokens.
daemon
Package daemon implements the Encore daemon gRPC server.
Package daemon implements the Encore daemon gRPC server.
daemon/dash
Package dash serves the Encore Developer Dashboard.
Package dash serves the Encore Developer Dashboard.
daemon/internal/manifest
Package manifest reads and writes Encore app manifests.
Package manifest reads and writes Encore app manifests.
daemon/internal/sym
Package sym parses symbol tables from Go binaries.
Package sym parses symbol tables from Go binaries.
daemon/run
Package run starts and tracks running Encore applications.
Package run starts and tracks running Encore applications.
daemon/secret
Package secret fetches and caches development secrets for Encore apps.
Package secret fetches and caches development secrets for Encore apps.
daemon/sqldb/external
Package external implements a cluster driver for an external cluster.
Package external implements a cluster driver for an external cluster.
internal/appfile
Package appfile reads and writes encore.app files.
Package appfile reads and writes encore.app files.
internal/browser
Package browser provides utilities for interacting with users' browsers.
Package browser provides utilities for interacting with users' browsers.
internal/codegen
Package codegen generates code for use with Encore apps.
Package codegen generates code for use with Encore apps.
internal/conf
Package conf writes and reads the Encore configuration file for the user.
Package conf writes and reads the Encore configuration file for the user.
internal/env
Package env answers where Encore tools and resources are located.
Package env answers where Encore tools and resources are located.
internal/gosym
Package gosym implements access to the Go symbol and line number tables embedded in Go binaries generated by the gc compilers.
Package gosym implements access to the Go symbol and line number tables embedded in Go binaries generated by the gc compilers.
internal/jsonrpc2
Package jsonrpc2 is a minimal implementation of the JSON RPC 2 spec.
Package jsonrpc2 is a minimal implementation of the JSON RPC 2 spec.
internal/jsonrpc2/servertest
Package servertest provides utilities for running tests against a remote LSP server.
Package servertest provides utilities for running tests against a remote LSP server.
internal/login
Package login handles login and authentication with Encore's platform.
Package login handles login and authentication with Encore's platform.
internal/wgtunnel
Package wgtunnel sets up and configures Encore's WireGuard tunnel for authenticating against private environments.
Package wgtunnel sets up and configures Encore's WireGuard tunnel for authenticating against private environments.
internal/xos
Package xos provides cross-platform helper functions.
Package xos provides cross-platform helper functions.
internal
gocodegen
Package gocodegen contains shared code used for generating Go code by both the compilers code generator, and the CLI's client generator.
Package gocodegen contains shared code used for generating Go code by both the compilers code generator, and the CLI's client generator.
Package parser parses Encore applications into an Encore Syntax Tree (EST).
Package parser parses Encore applications into an Encore Syntax Tree (EST).
est
Package est provides the Encore Syntax Tree (EST).
Package est provides the Encore Syntax Tree (EST).
paths
Package paths parses API paths.
Package paths parses API paths.
pkg
eerror
Package eerror stands for Encore Error and is used to provide a little more information about the underlying error's metadata.
Package eerror stands for Encore Error and is used to provide a little more information about the underlying error's metadata.
vcs
tools

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL