diff --git a/README.md b/README.md index 420a6b50..e1a116c0 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,34 @@ See [the announcement](https://blog.abp.io/abp/Introducing-the-eShopOnAbp-Projec Please open issues on the main GitHub repository: https://github.com/abpframework/abp/issues +### How to Run? +You can either run in Visual Studio, or using [Microsoft Tye](https://github.com/dotnet/tye). Tye is a developer tool that makes developing, testing, and deploying micro-services and distributed applications easier. + + #### Requirements + +- .NET 6.0+ +- Docker +- Yarn + +#### Instructions + +- Clone the repository ( [eShopOnAbp](https://github.com/abpframework/eShopOnAbp) ) + +- Install Tye (*follow [these steps](https://github.com/dotnet/tye/blob/main/docs/getting_started.md#installing-tye)*) + +- Execute `run-tye.ps1` + +- Wait until all applications are up! + + - You can check running application from tye dashboard ([localhost:8000](http://127.0.0.1:8000/)) + +- After all your backend services are up, start the angular application: + + ```bash + cd apps/angular + yarn start + ``` ### Roadmap