Add guidance to getting started (#122)

This commit is contained in:
Yaron Schneider 2019-10-15 15:05:37 -07:00 committed by GitHub
parent 71d3ac6de4
commit 7f34df0ebe
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 28 additions and 1 deletions

View File

@ -2,9 +2,36 @@
Dapr is a portable, event-driven runtime that makes it easy for enterprise developers to build resilient, microservice stateless and stateful applications that run on the cloud and edge and embraces the diversity of languages and developer frameworks.
To get started with Dapr, we recommend the following steps:
#### 1. Setup Dapr on your local machine or Kubernetes cluster
To build and run your Dapr applications, you will need to [setup your environment](./environment-setup.md) and install Dapr:
1. [Setup local development](./environment-setup.md#prerequisites)
2. [Setup Kubernetes environment](./environment-setup.md#installing-dapr-on-a-kubernetes-cluster)
Once Dapr is installed, you can try out [Hello-World sample](https://github.com/dapr/samples/tree/master/1.hello-world) first and then explore the other [Dapr samples](https://github.com/dapr/samples) to evaluate the [Dapr concepts](../concepts), such as service invocation, state management, pubsub, bindings, etc.
Once you have Dapr installed, you can continue to our [Hello World sample](https://github.com/dapr/samples/tree/master/1.hello-world) or continue reading for further guidance.
#### 2. Setup a state store and pub-sub (Optional)
Some features of Dapr, mainly [Pub/Sub](https://github.com/dapr/docs/tree/master/concepts/publish-subscribe-messaging) and [State Management](https://github.com/dapr/docs/blob/master/concepts/state-management/state-management.md), require that you set up a Dapr components for them.
Using the Dapr CLI, these components are set-up automatically for you when running on a local machine.<br><br>
The following links will help you setup a state store and pub/sub components on Kubernetes:
* [Setup State Management on Kubernetes](../howto/setup-state-store)
* [Setup Pub/Sub on Kubernetes](../howto/setup-pub-sub-message-broker)
#### 3. Run through concepts and how-to guides (Optional)
Dapr has many concepts, which can be found [here](../concepts).
The concepts provide a deeper understanding of the core features of Dapr and how they work.
Reading the [How To](../howto) guides, you can walk through specific tasks, for example, how to create a [rate limited app](../howto/control-concurrency) using Dapr.
#### 4. Run samples
The best way to learn is through experience! The Dapr [samples repo](https://github.com/dapr/samples) contains many samples that will walk you through end-to-end scenarios of building applications with Dapr involving service invocation, using pub/sub, handling state and more.