Updated getting started section in readme file. (#1538)
* Updated get started section in readme file. * Updated docker-compose specific link * Updated instructions in the readme file.
This commit is contained in:
parent
d2a1e5ac1e
commit
07a1caf566
31
README.md
31
README.md
@ -23,25 +23,40 @@ Sample .NET Core reference application, powered by Microsoft, based on a simplif
|
|||||||
|
|
||||||
_**Dev** branch contains the latest **beta** code and their images are tagged with `:linux-dev` in our [Docker Hub](https://hub.docker.com/u/eshop)_
|
_**Dev** branch contains the latest **beta** code and their images are tagged with `:linux-dev` in our [Docker Hub](https://hub.docker.com/u/eshop)_
|
||||||
|
|
||||||
## Are you new to **microservices** and **cloud-native development**?
|
|
||||||
Take a look at the free course [Create and deploy a cloud-native ASP.NET Core microservice](https://docs.microsoft.com/en-us/learn/modules/microservices-aspnet-core/) on MS Learn. This module explains microservices concepts, cloud-native technologies, and reduce the friction in getting started with `eShopOnContainers`.
|
|
||||||
|
|
||||||
## Getting Started
|
## Getting Started
|
||||||
|
|
||||||
*eShopOnContainers* is provided in two flavors: Basic and Advanced.
|
Make sure you have [installed](https://docs.docker.com/docker-for-windows/install/) and [configured](https://github.com/dotnet-architecture/eShopOnContainers/wiki/Windows-setup#configure-docker) docker in your environment. After that, you can run the below commands from the **/src/** directory and get started with the `eShopOnContainers` immediately.
|
||||||
|
|
||||||
|
```powershell
|
||||||
|
docker-compose build
|
||||||
|
docker-compose up
|
||||||
|
```
|
||||||
|
|
||||||
|
You should be able to browse different components of the application by using the below URLs :
|
||||||
|
|
||||||
|
```
|
||||||
|
Web Status : http://host.docker.internal:5107/
|
||||||
|
Web MVC : http://host.docker.internal:5100/
|
||||||
|
Web SPA : http://host.docker.internal:5104/
|
||||||
|
```
|
||||||
|
|
||||||
|
>!Note: If you are running this application in macOS then use `docker.for.mac.localhost` as DNS name in `.env` file and the above URLs instead of `host.docker.internal`.
|
||||||
|
|
||||||
|
Below are the other avenues to setup *eShopOnContainers*.
|
||||||
|
|
||||||
### Basic scenario
|
### Basic scenario
|
||||||
|
|
||||||
The basic scenario can be run locally using docker-compose, and also deployed to a local Kubernetes cluster. Refer to these Wiki pages to Get Started:
|
The basic scenario can be run locally using docker-compose, and also deployed to a local Kubernetes cluster. Refer to these Wiki pages to Get Started:
|
||||||
|
|
||||||
- [CLI or Visual Studio Code](https://github.com/dotnet-architecture/eShopOnContainers/wiki/Windows-setup)
|
|
||||||
- [Visual Studio (F5 experience)](https://github.com/dotnet-architecture/eShopOnContainers/wiki/Windows-setup#optional---use-visual-studio)
|
- [Visual Studio (F5 experience)](https://github.com/dotnet-architecture/eShopOnContainers/wiki/Windows-setup#optional---use-visual-studio)
|
||||||
- [Docker compose](https://github.com/dotnet-architecture/eShopOnContainers/wiki/Docker-compose-deployment-files)
|
- [Docker compose on windows](https://github.com/dotnet-architecture/eShopOnContainers/wiki/Windows-setup)
|
||||||
|
- [Docker compose on macOS](https://github.com/dotnet-architecture/eShopOnContainers/wiki/Mac-setup)
|
||||||
- [Local Kubernetes](https://github.com/dotnet-architecture/eShopOnContainers/wiki/Deploy-to-Local-Kubernetes)
|
- [Local Kubernetes](https://github.com/dotnet-architecture/eShopOnContainers/wiki/Deploy-to-Local-Kubernetes)
|
||||||
|
|
||||||
### Advanced scenario
|
### Advanced scenario
|
||||||
|
|
||||||
The Advanced scenario can be run only in a Kubernetes cluster. Currently this scenario is the same as basic scenario with the following differences:
|
The Advanced scenario can be run only in a Kubernetes cluster. Currently this scenario is the same as a basic scenario with the following differences:
|
||||||
|
|
||||||
- [Deploy to AKS with a Service Mesh for resiliency](https://github.com/dotnet-architecture/eShopOnContainers/wiki/Deploy-to-Azure-Kubernetes-Service-(AKS))
|
- [Deploy to AKS with a Service Mesh for resiliency](https://github.com/dotnet-architecture/eShopOnContainers/wiki/Deploy-to-Azure-Kubernetes-Service-(AKS))
|
||||||
|
|
||||||
@ -91,6 +106,8 @@ You can download them and start reviewing these Guides/eBooks here:
|
|||||||
|
|
||||||
For more free e-Books check out [.NET Architecture center](https://dot.net/architecture). If you have an e-book feedback, let us know by creating a new issue here: <https://github.com/dotnet-architecture/ebooks/issues>
|
For more free e-Books check out [.NET Architecture center](https://dot.net/architecture). If you have an e-book feedback, let us know by creating a new issue here: <https://github.com/dotnet-architecture/ebooks/issues>
|
||||||
|
|
||||||
|
## Are you new to **microservices** and **cloud-native development**?
|
||||||
|
Take a look at the free course [Create and deploy a cloud-native ASP.NET Core microservice](https://docs.microsoft.com/en-us/learn/modules/microservices-aspnet-core/) on MS Learn. This module explains microservices concepts, cloud-native technologies, and reduce the friction in getting started with `eShopOnContainers`.
|
||||||
|
|
||||||
## Read further
|
## Read further
|
||||||
|
|
||||||
|
Loading…
x
Reference in New Issue
Block a user