-
Notifications
You must be signed in to change notification settings - Fork 357
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Improved FAQ and Screenshots section (#156)
- Loading branch information
1 parent
d1b9e8f
commit f526e7d
Showing
1 changed file
with
41 additions
and
25 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -2,7 +2,15 @@ | |
| <a href="https://encore.dev" alt="encore"><img width="189px" src="https://encore.dev/assets/img/logo.svg"></a> | ||
| <h3><a href="https://encore.dev">Encore – The Backend Development Engine</a></h3> | ||
| </div> | ||
| Encore makes it super easy to create backend services and APIs. Built ground up for Go, Encore uses static analysis and code generation to provide a revolutionary developer experience that is extremely productive. | ||
| Encore makes it incredibly simple to create distributed systems, backend services and APIs. While still deploying to your own cloud account, Encore helps you escape the maze of cloud complexity:</br> | ||
|
|
||
| * No endless repetition of boilerplate | ||
|
|
||
| * No infrastructure to worry about | ||
|
|
||
| * No reinventing the wheel | ||
|
|
||
| Start building with a fantastic flow-state experience that unlocks your creative potential. <br/>All of this is freely available, based on the Open Source Encore Go Framework. | ||
| <br/><br/> | ||
|
|
||
| **🏁 Get started in minutes and check out the documentation: [encore.dev/docs](https://encore.dev/docs/quick-start)** | ||
|
|
@@ -11,8 +19,7 @@ Encore makes it super easy to create backend services and APIs. Built ground up | |
|
|
||
| ## Key features | ||
|
|
||
| * **[No Boilerplate](https://encore.dev/docs/develop/services-and-apis):** Set up a production ready backend application in minutes. Define services, API endpoints, | ||
| and call APIs with a single line of Go code. | ||
| * **[No Boilerplate](https://encore.dev/docs/develop/services-and-apis):** Set up a production ready backend application in minutes. Define services, API endpoints, and call APIs with a single line of Go code. | ||
|
|
||
| * **[Databases Made Simple](https://encore.dev/docs/concepts/databases):** Define the schema and then start querying. Encore takes care of provisioning, migrations, connections and passwords. | ||
|
|
||
|
|
@@ -28,7 +35,7 @@ Encore makes it super easy to create backend services and APIs. Built ground up | |
|
|
||
| * **[Simple Secrets](https://encore.dev/docs/develop/secrets):** It's never been this easy to store and securely use secrets and API keys. Define secrets in your code like any other variable, Encore takes care of the rest. | ||
|
|
||
| * **[API Documentation](https://encore.dev/docs/develop/api-docs):** Encore parses your source code to understand the request/response | ||
| * **[Automated API Documentation](https://encore.dev/docs/develop/api-docs):** 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. | ||
|
|
||
|
|
@@ -38,20 +45,27 @@ Encore makes it super easy to create backend services and APIs. Built ground up | |
|
|
||
| To start using Encore, follow our simple [Quick Start Guide](https://encore.dev/docs/quick-start). | ||
|
|
||
| ## Screenshots | ||
|
|
||
| ### Setup Demo | ||
| [](https://asciinema.org/a/406681) | ||
| ### Simple Cloud Environments | ||
|
|
||
| ### Database Demo | ||
| [](https://asciinema.org/a/406695) | ||
| <img src="https://encore.dev/assets/github/environments.png" alt="Simple Cloud Environments" width=50% height=50%> | ||
|
|
||
| ### API Documentation | ||
| ### Automatic Infrastructure Provisioning | ||
|
|
||
| [](https://encore.dev/docs/concepts/api-docs) | ||
| <img src="https://encore.dev/assets/github/infrastructure.png" alt="Automatic Infrastructure Provisioning" width=50% height=50%> | ||
|
|
||
| ### Distributed Tracing | ||
|
|
||
| [](https://encore.dev/docs/observability/tracing) | ||
| <img src="https://encore.dev/assets/github/tracing.png" alt="Distributed Tracing" width=50% height=50%> | ||
|
|
||
| ### Automated API Documentation | ||
|
|
||
| <img src="https://encore.dev/assets/github/documentation.png" alt="Automated API Documentation" width=50% height=50%> | ||
|
|
||
| ### Native Cron Jobs | ||
|
|
||
| <img src="https://encore.dev/assets/github/cronjobs.png" alt="Native Cron Jobs" width=50% height=50%> | ||
|
|
||
| ## Contributing to Encore and building from source | ||
|
|
||
|
|
@@ -61,33 +75,35 @@ See [CONTRIBUTING.md](CONTRIBUTING.md). | |
|
|
||
| #### Who's behind Encore? | ||
|
|
||
| We're long-time Staff Engineers from Spotify, who grew frustrated with all the boilerplate and boring stuff you have to do to build modern cloud applications. | ||
| 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. | ||
|
|
||
| #### Why is the framework integrated with cloud hosting? | ||
| 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. | ||
|
|
||
| We've found that to meaningfully improve developer productivity you have to operate across the full stack. Unless you understand how an application is deployed, there are lots of things in the development process that you can't simplify. You can still use your own account with any of the major cloud providers (AWS/Azure/GCP), or you can use Encore's cloud for free, for Hobby projects, with pretty generous "fair use" limits. | ||
| #### Who is Encore for? | ||
|
|
||
| #### Can I use an existing Kubernetes cluster with Encore? | ||
| 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. | ||
|
|
||
| Not right now. We definitely want to support deploying to an existing k8s cluster, and enable more flexible deployment topologies in general. It's a bit tricky since we set up the cluster in a certain way, and it's hard to know how the existing cluster is configured and we don't want to break any existing application that might be running there. | ||
| 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. | ||
|
|
||
| #### Can you have it provision in Kubernetes rather than a cloud infrastructure? | ||
| 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. | ||
|
|
||
| Right now we only support deploying Encore apps to managed services such as AWS Lambda/Google Cloud Run. | ||
| Either where we host it for you (using GCP under the hood), or you can tell Encore to deploy to your own cloud account. | ||
| In that case we set it up in a serverless fashion like Lambda/Cloud Run. | ||
| #### How is Encore different? | ||
|
|
||
| #### Does Encore support using websockets? | ||
| 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. | ||
|
|
||
| Encore supports dropping down to plain HTTP requests which lets you use Websockets. | ||
| 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. | ||
|
|
||
| ## Get Involved | ||
| We rely on your contributions and feedback to improve Encore. | ||
| We love hearing about your experiences using Encore, and about what may be unclear and we can do a better job explaining. | ||
|
|
||
| * ⭐ Star this repository to help spread the word. | ||
| * Send us feedback or ask questions via [email](mailto:[email protected]). | ||
| * Connect with other Encore users on [Slack](https://encore.dev/slack). | ||
| * Join the most pioneering developer community on [Slack](https://encore.dev/slack). | ||
| * Follow us on [Twitter](https://twitter.com/encoredotdev). | ||
| * Leave feedback on our [Product Roadmap](https://encore.dev/roadmap). | ||
| * Send us feedback or ask questions via [email](mailto:[email protected]). | ||
| * Leave feedback on our [Public Roadmap](https://encore.dev/roadmap). | ||
| * [Book a session](https://calendly.com/encoreandre/encore-office-hours) to speak with us directly. | ||