Skip to content

Commit dd9fb42

Browse files
author
Сергей Трегуб
committed
Update README
1 parent 672f6eb commit dd9fb42

1 file changed

Lines changed: 22 additions & 2 deletions

File tree

README.md

Lines changed: 22 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# ASP.Net Core RESTful Service Template
22

3-
The repository contains a ready to use preconfigured project template for MS Visual Studio 2017 and 2019 to create fully functional production-ready cross-platform RESTful services based on ASP.Net Core 3.1.
3+
The repository contains a ready to use preconfigured project template for MS Visual Studio 2017 and 2019 to create fully functional production-ready cross-platform RESTful services based on ASP.Net Core 3.1/5.0.
44

55
> Note 1. ASP.NET Core 3.0 has many breaking changes against version 2.2. If you want to use v2.2 or earlier, please, check out one of the previous releases, starting from [version 1.3](https://github.com/drwatson1/AspNet-Core-REST-Service/releases/tag/v1.3) or earlier.
66
>
@@ -24,7 +24,7 @@ Let me know, what do you think. Any suggestions and bug reports are very appreci
2424

2525
# Getting Started
2626

27-
27+
## Using Visual Studio
2828
1. Install the extension from [Visual Studio Marketplace](https://marketplace.visualstudio.com/items?itemName=sergey-tregub.asp-net-core-restful-service-template#overview) or download and install the latest version from [GitHub](https://github.com/drwatson1/AspNet-Core-REST-Service/releases/latest). Also, you can install it from Visual Studio. To do so click on "Tools/Extensions and Updates..." menu item, then select "Online/Visual Studio Marketplace/Templates" on the left pane, search for "ASP.Net Core RESTful Service Template," select it and click "Download" button. Please note! The latest version of the template is targeted to the .Net Core 3.1. If you need a template for 2.x version use one of the previous version of the template.
2929
1. Restart Visual Studio
3030
1. Click on "File/New Project..." menu item
@@ -34,6 +34,25 @@ Let me know, what do you think. Any suggestions and bug reports are very appreci
3434
1. Open a browser and navigate to [http://localhost:5000/swagger](http://localhost:5000/swagger) to see an API documentation
3535
1. Play around with the API. Try to add a new product or update one
3636

37+
## Using command line
38+
39+
1. Install the template:
40+
```
41+
dotnet new -i DrWatson1.ProjectTemplate.RestAPI
42+
```
43+
2. Create a project:
44+
```
45+
dotnet new rest-api -n ASPNetCoreService
46+
```
47+
It creates a new project "ASPNetCoreService" in the corresponding subfolder.
48+
Replace the "ASPNetCoreService" with a desired name.
49+
3. Run the project:
50+
```
51+
dotnet run
52+
```
53+
4. Open a browser and navigate to [http://localhost:5000/swagger](http://localhost:5000/swagger) to see an API documentation
54+
5. Play around with the API. Try to add a new product or update one
55+
3756
Visit project [Wiki](https://github.com/drwatson1/AspNet-Core-REST-Service/wiki) pages to learn more about the template.
3857

3958
Have fun and happy hacking!
@@ -42,6 +61,7 @@ Have fun and happy hacking!
4261

4362
|Date | Version | Release Notes |
4463
|-----|---------|---------------|
64+
|2021-05-03|2.6|<p>- Support of .Net 5.0<p>- Add `dotnet new` custom template
4565
|2021-03-07|2.5|<p>- Minor fixes |
4666
|2021-02-27|2.4|<p>- Improve logging |
4767
|2021-02-23|2.3|<p>- Load .env before Serilog initialization to make it possible to use environment variables in Serilog configuration options<p>- Catch and log unhandled exceptions <p>- Update NuGet packages to the latest versions|

0 commit comments

Comments
 (0)