Skip to content

Commit 297e5da

Browse files
committed
doc(aspnetcore): update readme files
1 parent d17bc97 commit 297e5da

File tree

2 files changed

+58
-68
lines changed
  • skeleton-esnext-aspnetcore/src/skeleton
  • skeleton-typescript-aspnetcore/src/skeleton

2 files changed

+58
-68
lines changed

skeleton-esnext-aspnetcore/src/skeleton/README.md

+29-32
Original file line numberDiff line numberDiff line change
@@ -1,51 +1,49 @@
11
# Aurelia with ASP.Net Core using ESNEXT
22

3-
## Running The App
3+
This skeleton works both with and without Visual Studio; however, the steps for getting up and running are different for these two scenarios. Please follow the correct set of instructions based on whether or not you are using Visual Studio.
4+
5+
First, there are a set of prerequisites you will need whether or not you are using Visual Studio. Make sure to install these prerequisites before proceeding.
6+
7+
- [NodeJS](http://nodejs.org/) >=4.0.0 This provides the platform on which the build tooling runs. This may be downloaded and installed from the NodeJS website.
8+
- NPM >=3.0.0 This is installed with NodeJS, but if you install a 4.x version of NodeJS, you may have to update this.
9+
- jspm and gulp. These two tools may be installed by running `npm install -g jspm gulp` from a command line after installing NodeJS and NPM
10+
> **Note:** Sometimes jspm queries GitHub to install packages, but GitHub has a rate limit on anonymous API requests. If you receive a rate limit error, you need to configure jspm with your GitHub credentials. You can do this by executing `jspm registry config github` and following the prompts. If you choose to authorize jspm by an access token instead of giving your password (see GitHub `Settings > Personal Access Tokens`), `public_repo` access for the token is required.
11+
12+
## Running the App in Visual Studio 2015
13+
14+
Additional Prerequisites:
15+
- Visual Studio 2015 with Update 3
16+
- [ASP.NET Core](https://www.microsoft.com/net/core#windows) must be downloaded and installed. The directions for doing this are [here](https://www.microsoft.com/net/core#windows).
17+
18+
1. Open the solution file `skeleton-typescript-aspnetcore.sln`. This file is located up two directories from the file. Visual Studio will automatically run `npm install` and `jspm install` when you first open the solution. You may rerun these commands at any time by running `npm install` from the same directory this readme file is in.
19+
2. Open `Task Runner Explorer`.
20+
3. The project is ready to be run when `Task Runner Explorer` shows that it is running the `gulp watch` command.
21+
4. Press `F5` or click the `Run` button in Visual Studio. Visual Studio will launch your browser for you and navigate to the correct URL.
22+
23+
24+
## Running The App without Visual Studio
25+
26+
Additional Prerequisites:
27+
- [ASP.NET Core](https://www.microsoft.com/net/core#windows) must be downloaded and installed. The directions for doing this are [here](https://www.microsoft.com/net/core#windows). You only need to download and install the `.NET Core SDK for Windows`.
428

529
To run the app, follow these steps.
630

7-
1. Ensure that [NodeJS](http://nodejs.org/) is installed. This provides the platform on which the build tooling runs.
8-
2. From the project folder, execute the following command:
31+
1. Install the npm devdependencies and jspm dependencies. From the project folder, execute the following command:
932
```shell
1033
npm install
1134
```
12-
3. Ensure that [Gulp](http://gulpjs.com/) is installed globally. If you need to install it, use the following command:
13-
```shell
14-
npm install -g gulp
15-
```
16-
> **Note:** Gulp must be installed globally, but a local version will also be installed to ensure a compatible version is used for the project.
17-
4. Ensure that [jspm](http://jspm.io/) is installed globally. If you need to install it, use the following command:
18-
```shell
19-
npm install -g jspm
20-
```
21-
> **Note:** jspm must be installed globally, but a local version will also be installed to ensure a compatible version is used for the project.
22-
23-
> **Note:** Sometimes jspm queries GitHub to install packages, but GitHub has a rate limit on anonymous API requests. If you receive a rate limit error, you need to configure jspm with your GitHub credentials. You can do this by executing `jspm registry config github` and following the prompts. If you choose to authorize jspm by an access token instead of giving your password (see GitHub `Settings > Personal Access Tokens`), `public_repo` access for the token is required.
24-
5. Install the client-side dependencies with jspm:
2535

26-
```shell
27-
jspm install -y
28-
```
36+
This command will install the npm dependencies, and then run `jspm install -y` for you. If you do not desire for this behavior, you may edit or remove the `postinstall` script in the `package.json` file.
2937
>**Note:** Windows users, if you experience an error of "unknown command unzip" you can solve this problem by doing `npm install -g unzip` and then re-running `jspm install`.
3038
31-
6. Build the project:
39+
6. Build the project:
3240

3341
```shell
3442
gulp build
3543
dotnet build
3644
```
3745

38-
>**Note:** This skeleton is wrapped in an ASP.Net Core 1.0 RTM project. If you are using VSCode on any platform you can install
39-
ASP.Net Core on Windows, OSX, or Linux. The instructions to do so are found
40-
[on this Microsoft page](https://www.microsoft.com/net/core).
41-
This assumes you are running from command line but Visual Studio users should be familiar with how to build and run the project
42-
in the IDE.
43-
44-
>**Note:** To use this project in Visual Studio requires the installation of Visual Studio 2015 Update 3 as well as the ASP.Net Core VS2015 Tooling Preview 2.
45-
They both may be found
46-
[on this Microsoft page](https://www.microsoft.com/net/core#windows).
47-
48-
7. Before you can run the .NET app, you must execute the following command:
46+
7. Execute the following command:
4947

5048
```shell
5149
dotnet restore
@@ -56,7 +54,6 @@ They both may be found
5654
```shell
5755
dotnet run
5856
```
59-
Or in Visual Studio just click on the Debug.Start Debugging (F5) or Debug.Start Without Debugging (Ctrl-F5) in the main menu..
6057

6158
9. If you want the changes you are making to be reflected in the browser you can run `gulp watch` in a second terminal window and refresh the page in your browser.
6259

skeleton-typescript-aspnetcore/src/skeleton/README.md

+29-36
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,39 @@
1-
# Aurelia with ASP.Net Core using TypeScript
1+
# Aurelia with ASP.NET Core using TypeScript
22

3-
## Running The App
3+
This skeleton works both with and without Visual Studio; however, the steps for getting up and running are different for these two scenarios. Please follow the correct set of instructions based on whether or not you are using Visual Studio.
4+
5+
First, there are a set of prerequisites you will need whether or not you are using Visual Studio. Make sure to install these prerequisites before proceeding.
6+
7+
- [NodeJS](http://nodejs.org/) >=4.0.0 This provides the platform on which the build tooling runs. This may be downloaded and installed from the NodeJS website.
8+
- NPM >=3.0.0 This is installed with NodeJS, but if you install a 4.x version of NodeJS, you may have to update this.
9+
- jspm, gulp, and typings. These three tools may be installed by running `npm install -g jspm gulp typings` from a command line after installing NodeJS and NPM
10+
> **Note:** Sometimes jspm queries GitHub to install packages, but GitHub has a rate limit on anonymous API requests. If you receive a rate limit error, you need to configure jspm with your GitHub credentials. You can do this by executing `jspm registry config github` and following the prompts. If you choose to authorize jspm by an access token instead of giving your password (see GitHub `Settings > Personal Access Tokens`), `public_repo` access for the token is required.
11+
12+
## Running the App in Visual Studio 2015
13+
14+
Additional Prerequisites:
15+
- Visual Studio 2015 with Update 3
16+
- [ASP.NET Core](https://www.microsoft.com/net/core#windows) must be downloaded and installed. The directions for doing this are [here](https://www.microsoft.com/net/core#windows).
17+
18+
1. Open the solution file `skeleton-typescript-aspnetcore.sln`. This file is located up two directories from the file. Visual Studio will automatically run `npm install`, `jspm install`, and `typings install` when you first open the solution. You may rerun these commands at any time by running `npm install` from the same directory this readme file is in.
19+
2. Open `Task Runner Explorer`.
20+
3. The project is ready to be run when `Task Runner Explorer` shows that it is running the `gulp watch` command.
21+
4. Press `F5` or click the `Run` button in Visual Studio. Visual Studio will launch your browser for you and navigate to the correct URL.
22+
23+
24+
## Running The App without Visual Studio
25+
26+
Additional Prerequisites:
27+
- [ASP.NET Core](https://www.microsoft.com/net/core#windows) must be downloaded and installed. The directions for doing this are [here](https://www.microsoft.com/net/core#windows). You only need to download and install the `.NET Core SDK for Windows`.
428

529
To run the app, follow these steps.
630

7-
1. Ensure that [NodeJS](http://nodejs.org/) is installed. This provides the platform on which the build tooling runs.
8-
2. Ensure that the typings tool is installed globally.
9-
```shell
10-
npm install -g typings
11-
```
12-
2. Install the npm devdependencies and the type .d.ts files. From the project folder, execute the following command:
31+
1. Install the npm devdependencies, jspm dependencies, and the typings .d.ts files. From the project folder, execute the following command:
1332
```shell
1433
npm install
1534
```
16-
3. Ensure that [Gulp](http://gulpjs.com/) is installed globally. If you need to install it, use the following command:
17-
```shell
18-
npm install -g gulp
19-
```
20-
> **Note:** Gulp must be installed globally, but a local version will also be installed to ensure a compatible version is used for the project.
21-
4. Ensure that [jspm](http://jspm.io/) is installed globally. If you need to install it, use the following command:
22-
```shell
23-
npm install -g jspm
24-
```
25-
> **Note:** jspm must be installed globally, but a local version will also be installed to ensure a compatible version is used for the project.
26-
27-
> **Note:** Sometimes jspm queries GitHub to install packages, but GitHub has a rate limit on anonymous API requests. If you receive a rate limit error, you need to configure jspm with your GitHub credentials. You can do this by executing `jspm registry config github` and following the prompts. If you choose to authorize jspm by an access token instead of giving your password (see GitHub `Settings > Personal Access Tokens`), `public_repo` access for the token is required.
28-
5. Install the client-side dependencies with jspm:
2935

30-
```shell
31-
jspm install -y
32-
```
36+
This command will install the npm dependencies, and then run `jspm install -y` and `typings install` for you. If you do not desire for this behavior, you may edit or remove the `postinstall` script in the `package.json` file.
3337
>**Note:** Windows users, if you experience an error of "unknown command unzip" you can solve this problem by doing `npm install -g unzip` and then re-running `jspm install`.
3438
3539
6. Build the project:
@@ -39,17 +43,7 @@ To run the app, follow these steps.
3943
dotnet build
4044
```
4145

42-
>**Note:** This skeleton is wrapped in an ASP.Net Core 1.0 RTM project. If you are using VSCode on any platform you can install
43-
ASP.Net Core on Windows, OSX, or Linux. The instructions to do so are found
44-
[on this Microsoft page](https://www.microsoft.com/net/core).
45-
This assumes you are running from command line but Visual Studio users should be familiar with how to build and run the project
46-
in the IDE.
47-
48-
>**Note:** To use this project in Visual Studio requires the installation of Visual Studio 2015 Update 3 as well as the ASP.Net Core VS2015 Tooling Preview 2.
49-
They both may be found
50-
[on this Microsoft page](https://www.microsoft.com/net/core#windows).
51-
52-
7. If you are working from the command line, before you can run the .NET app, you must execute the following command:
46+
7. Execute the following command:
5347

5448
```shell
5549
dotnet restore
@@ -60,7 +54,6 @@ They both may be found
6054
```shell
6155
dotnet run
6256
```
63-
Or in Visual Studio just click on the Debug.Start Debugging (F5) or Debug.Start Without Debugging (Ctrl-F5) in the main menu..
6457

6558
9. If you want the changes you are making to be reflected in the browser you can run `gulp watch` in a second terminal window and refresh the page in your browser.
6659

0 commit comments

Comments
 (0)