Skip to content

Commit 05c40df

Browse files
authored
update readme for ga (dotnet#776)
1 parent e6c0254 commit 05c40df

File tree

5 files changed

+104
-200
lines changed

5 files changed

+104
-200
lines changed

docs/contributing.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# Set up your machine to contribute
2+
3+
These instructions will get you ready to contribute to this project. If you just want to use Aspire, see [using-latest-daily.md](using-latest-daily.md).
4+
5+
## Prepare the machine
6+
7+
See [machine-requirements.md](machine-requirements.md).
8+
9+
## Build the repo
10+
`.\build.cmd` (Windows) or `.\build.sh` (macOS and Linux)
11+
12+
13+
## Run eShopLite
14+
15+
This will confirm that you're all set up.
16+
17+
If you are using Visual Studio:
18+
19+
1. Open `Aspire.sln`
20+
1. Set the Startup Project to be the `AppHost` project (it's under `\samples\eShopLite`). Make sure the launch profile is set to "http".
21+
1. <kbd>F5</kbd> to debug, or <kbd>Ctrl+F5</kbd> to launch without debugging.
22+
23+
Otherwise:
24+
```shell
25+
dotnet restore samples/eShopLite/AppHost/AppHost.csproj
26+
dotnet run --project samples/eShopLite/AppHost/AppHost.csproj
27+
```
28+
29+
## View Dashboard
30+
31+
When you start the sample app in Visual Studio, it will automatically open your browser to show the dashboard.
32+
33+
Otherwise if you are using the command line, when you have the Aspire app running, open the dashboard URL in your browser. The URL is shown in the app's console output like this: `Now listening on: http://localhost:15888`. You can change the default URL in the launchSettings.json file in the AppHost project.
34+
35+
## Tips and known issues
36+
37+
Make sure you have started Docker before trying to run an Aspire app.
38+
39+
See the [tips and known issues](tips-and-known-issues.md) page.

docs/getting-started.md

Lines changed: 0 additions & 138 deletions
This file was deleted.

docs/machine-requirements.md

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,21 @@
11
# Set up your environment
22

3-
## Install Visual Studio 2022 Internal Preview (dogfood)
3+
Whether you want to contribute to Aspire, or just use the latest build of Aspire, these are the common pieces you need to install.
44

5-
[Visual Studio 2022 Enterprise IntPreview Setup](https://aka.ms/vs/17/intpreview/vs_enterprise.exe)
6-
- This channel updates nightly. You need a build from 12-Oct-2023 or later.
5+
## (Windows) Install Visual Studio
76

8-
## Install .NET 8 RTM nightly SDK
7+
On Windows, Visual Studio contains special tooling support for .NET Aspire that you will want to have.
98

10-
Install the .NET 8 RTM nightly SDK version 8.0.100-rtm.23512.16 or newer:
11-
1. [Windows x64 link](https://dotnetbuilds.azureedge.net/public/Sdk/8.0.100-rtm.23512.16/dotnet-sdk-8.0.100-rtm.23512.16-win-x64.exe)
12-
2. [Linux x64 link](https://dotnetbuilds.azureedge.net/public/Sdk/8.0.100-rtm.23512.16/dotnet-sdk-8.0.100-rtm.23512.16-linux-x64.tar.gz)
13-
3. [MacOS x64 link](https://dotnetbuilds.azureedge.net/public/Sdk/8.0.100-rtm.23512.16/dotnet-sdk-8.0.100-rtm.23512.16-osx-x64.tar.gz)
14-
4. [MacOS ARM64](https://dotnetbuilds.azureedge.net/public/Sdk/8.0.100-rtm.23512.16/dotnet-sdk-8.0.100-rtm.23512.16-osx-arm64.tar.gz)
9+
[Visual Studio 2022 version 17.9 Preview](https://visualstudio.microsoft.com/vs/preview/)
10+
11+
When you install, ensure that both:
12+
* `ASP.NET and web development` Workload is checked.
13+
* `.NET Aspire SDK` component in `Individual components` is checked.
14+
15+
## Install the latest .NET 8 SDK
16+
[.NET 8 SDK](https://github.com/dotnet/installer#installers-and-binaries)
1517

1618
## Install Docker Desktop
1719
* [Windows](https://docs.docker.com/desktop/install/windows-install/)
1820
* [MacOS X](https://docs.docker.com/desktop/install/mac-install/)
1921
* [Linux](https://docs.docker.com/desktop/install/linux-install/)
20-

docs/repo-instructions.md

Lines changed: 0 additions & 52 deletions
This file was deleted.

docs/using-latest-daily.md

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
# Set up your machine to use the latest Aspire builds
2+
3+
These instructions will get you set up with the latest build of Aspire. If you just want the last preview release of .NET Aspire, the packages are on nuget.org, and install the latest [Visual Studio 2022 version 17.9 Preview](https://visualstudio.microsoft.com/vs/preview/) for the tooling.
4+
5+
## Prepare the machine
6+
7+
See [machine-requirements.md](machine-requirements.md).
8+
9+
## Add necessary NuGet feeds
10+
11+
The latest builds are pushed to a special feed, which you need to add:
12+
```sh
13+
dotnet nuget add source --name dotnet8 https://pkgs.dev.azure.com/dnceng/public/_packaging/dotnet8/nuget/v3/index.json
14+
```
15+
16+
As usual this will add the feed to any existing NuGet.config in the directory or above, or else in the global NuGet.config. See [configuring NuGet behavior](https://learn.microsoft.com/en-us/nuget/consume-packages/configuring-nuget-behavior) to read more about that.
17+
18+
Alternatively, if you are using Visual Studio, you can [Install and manage packages in Visual Studio](https://learn.microsoft.com/nuget/consume-packages/install-use-packages-visual-studio#package-sources) and add the feed `https://pkgs.dev.azure.com/dnceng/public/_packaging/dotnet8/nuget/v3/index.json` there.
19+
20+
## Install the .NET Aspire dotnet workload
21+
22+
This will actually get Aspire components.
23+
24+
```shell
25+
dotnet workload install aspire --skip-sign-check --interactive --source https://pkgs.dev.azure.com/dnceng/public/_packaging/dotnet8/nuget/v3/index.json
26+
# To update it later if you wish
27+
# dotnet workload update --source https://pkgs.dev.azure.com/dnceng/public/_packaging/dotnet8/nuget/v3/index.json
28+
```
29+
30+
Now you are ready to create and run an Aspire app using these latest Aspire components.
31+
32+
## Create a new Project
33+
34+
Create an empty .NET Aspire project on the command line:
35+
```shell
36+
dotnet new aspire
37+
# Alternatively, to create a .NET Aspire project using the Starter template:
38+
# dotnet new aspire-starter
39+
```
40+
41+
These will create a `.sln` file and at least two projects.
42+
43+
Assuming the NuGet feed you added above is visible -- for example you added it globally or it's in a NuGet.config in this folder - you can now build that `.sln`
44+
```shell
45+
dotnet restore
46+
dotnet build
47+
```
48+
49+
And then run it (make sure that Docker desktop is started):
50+
```shell
51+
dotnet run --project "<directoryname>.AppHost"
52+
```
53+
54+
Alternatively, if you are using Visual Studio, you can instead create a new Blazor Web App project and check the `Enlist in Aspire orchestration` box while creating it. Then use <kbd>F5</kbd> to debug or <kbd>Ctrl+F5</kbd> to launch without debugging.

0 commit comments

Comments
 (0)