You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+31-4Lines changed: 31 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -20,8 +20,12 @@ A list of Frequently Asked Questions about this repository can be found [here](h
20
20
-[Linux/MacOS](#linuxmacos)
21
21
-[Running the sample locally](#running-the-sample-locally)
22
22
-[Configuring the sample to use SQL Server](#configuring-the-sample-to-use-sql-server)
23
-
-[Running the sample in the dev container](#running-the-sample-in-the-dev-container)
23
+
-[Dev Containers for the eShopOnWeb repo](#dev-containers-for-the-eshoponweb-repo)
24
+
-[eShopOnWeb App Dev Container](#eshoponweb-app-dev-container)
25
+
-[eShopOnWeb Docs Dev Container](#eshoponweb-docs-dev-container)
26
+
-[Learn More about Dev Containers](#learn-more-about-dev-containers)
24
27
-[Running the sample using Docker](#running-the-sample-using-docker)
28
+
-[Getting the GitHub Single Sign-On Working](#getting-the-github-single-sign-on-working)
25
29
-[Community Extensions](#community-extensions)
26
30
27
31
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
@@ -110,7 +114,7 @@ According to the prompt, enter an `env name`, and select `subscription` and `loc
110
114
You can also run the sample directly locally (See below).
111
115
112
116
## Running the sample locally
113
-
Most of the site's functionality works with just the web application running. However, the site's Admin page relies on Blazor WebAssembly running in the browser, and it must communicate with the server using the site's PublicApi web application. You'll need to also run this project. You can configure Visual Studio to start multiple projects, or just go to the PublicApi folder in a terminal window and run `dotnet run` from there. After that from the Web folder you should run `dotnet run --launch-profile Web`. Now you should be able to browse to `https://localhost:5001/`. The admin part in Blazor is accessible to `https://localhost:5001/admin`
117
+
Most of the site's functionality works with just the web application running. However, the site's Admin page relies on Blazor WebAssembly running in the browser, and it must communicate with the server using the site's PublicApi web application. You'll need to also run this project. You can configure Visual Studio to start multiple projects, or just go to the PublicApi folder in a terminal window and run `dotnet run` from there. After that from the Web folder you should run `dotnet run --launch-profile https`. Now you should be able to browse to `https://localhost:5001/`. The admin part in Blazor is accessible to `https://localhost:5001/admin`
114
118
115
119
Note that if you use this approach, you'll need to stop the application manually in order to build the solution (otherwise you'll get file locking errors).
116
120
@@ -160,13 +164,28 @@ You can also run the samples in Docker (see below).
We use dev containers to make it easier for you to run the eShopOnWeb application locally as well as our documentation.
170
+
171
+
### eShopOnWeb App Dev Container
164
172
165
173
This project includes a `.devcontainer` folder with a [dev container configuration](https://containers.dev/), which lets you use a container as a full-featured dev environment.
166
174
167
175
You can use the dev container to build and run the app without needing to install any of its tools locally! You can work in GitHub Codespaces or the VS Code Dev Containers extension.
168
176
169
-
Learn more about using the dev container in its [readme](/.devcontainer/devcontainerreadme.md).
177
+
Learn more about using the dev container in [eShopOnWeb's dev container readme](/.devcontainer/devcontainerreadme.md).
178
+
179
+
### eShopOnWeb Docs Dev Container
180
+
181
+
If you want to help maintain [the documentation](https://nimblepros.github.io/eShopOnWeb/), we have a [.devcontainer folder within the docs folder](/docs/.devcontainer). This allows us to see our documentation changes in a container running Ruby and the GitHub Pages environment.
182
+
183
+
### Learn More about Dev Containers
184
+
185
+
- [NimblePros YouTube: Run GitHub Pages Locally in a Dev Container](https://www.youtube.com/watch?v=JpLJi5JBmYM&t=5s)
186
+
- [NimblePros Blog: Run GitHub Pages Locally in a Dev Container](https://blog.nimblepros.com/blogs/github-pages-with-dev-containers/)
187
+
- [NimblePros Blog: Introduction to Dev Containers](https://blog.nimblepros.com/blogs/introduction-to-dev-containers/)
188
+
- [NimblePros Webinar: Dev Containers Unwrapped!](https://www.youtube.com/watch?v=Wvetp2YkwPY)
170
189
171
190
## Running the sample using Docker
172
191
@@ -181,6 +200,14 @@ You should be able to make requests to localhost:5106 for the Web project, and l
181
200
182
201
You can also run the applications by using the instructions located in their `Dockerfile` file in the root of each project. Again, run these commands from the root of the solution (where the .sln file is located).
183
202
203
+
## Getting the GitHub Single Sign-On Working
204
+
205
+
We include GitHub as our external provider for single sign-on.
206
+
207
+
To get it running locally, you'll want to register an application in GitHub and store values in user secrets for the client ID and client secret.
208
+
209
+
We explain the code in detail in our course on [ASP.NET Identity in Action: Implementing Individual Accounts](https://academy.nimblepros.com/p/applying-identity-to-asp-net).
210
+
184
211
## Community Extensions
185
212
186
213
We have some great contributions from the community, and while these aren't maintained by Microsoft we still want to highlight them.
This allows us to preview the docs locally without having to install Ruby or Jekyll on our machines.
4
+
5
+
These docs are hosted on GitHub Pages and use the Just-the-Docs theme.
6
+
7
+
For more information on dev containers, see [the main README's section on dev containers](../../README.md#dev-containers-for-the-eshoponweb-repo) for details.
8
+
9
+
## Docs Hosting Environment
10
+
11
+
The docs are hosted on GitHub Pages. GitHub provides a [GitHub Pages Ruby Gem](https://github.com/github/pages-gem) to make it easy for us to run this locally.
12
+
13
+
If you want to know more about the dependencies of the GitHub Pages Ruby Gem, they keep track of [Dependency versions](https://pages.github.com/versions/).
0 commit comments