Skip to content

Commit 5d5ad09

Browse files
authored
Update README.md
1 parent f169b70 commit 5d5ad09

File tree

1 file changed

+62
-16
lines changed

1 file changed

+62
-16
lines changed

content/README.md

Lines changed: 62 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,34 @@
11
# ASP.NET Core & Vue.js Starter
22

3-
### Made with :heart: by [Trilon.io](https://trilon.io)
4-
<p>
3+
Starter Template for ASP.NET Core and Vue.JS (Vue) - with Webpack (with HMR), Web API, Vuex state manangement and other best-practices baked in!
4+
5+
> Written in ES6, TypeScript version coming soon!
6+
7+
[![Nuget](https://img.shields.io/nuget/v/aspnetcore-vuejs.svg?style=for-the-badge&color=5b1096)](https://www.nuget.org/packages/aspnetcore-vuejs/)
8+
[![Nuget Downloads](https://img.shields.io/nuget/dt/aspnetcore-vuejs.svg?label=Nuget%20Downloads&style=for-the-badge&color=b31ae7)](https://www.nuget.org/packages/aspnetcore-vuejs/)
9+
[![MIT License](https://img.shields.io/badge/license-MIT-blue.svg?style=for-the-badge&color=e51384)](/LICENSE)
10+
11+
---
12+
13+
<br>
14+
<p align="center">
515
<a href="https://trilon.io" target="_blank">
6-
<img width="200" height="auto" src="https://trilon.io/meta/og-image.png" alt="Trilon.io - Angular Universal, NestJS, JavaScript Application Consulting Development and Training">
16+
<img width="500" height="auto" src="https://trilon.io/trilon-logo-clear.png" alt="Trilon.io - Angular Universal, NestJS, JavaScript Application Consulting Development and Training">
717
</a>
818
</p>
919

10-
_Looking for ASP.NET Core & Angular 7.x+ Universal starter? [click here](https://github.com/TrilonIO/aspnetcore-angular-universal)_
20+
21+
<h3 align="center"> Made with :heart: by <a href="https://trilon.io">Trilon.io</a></h3>
1122

1223
---
1324

25+
1426
# Table of Contents
1527

1628
* [Features](#features)
1729
* [Prerequisites](#prerequisites)
1830
* [Installation](#installation)
19-
* [Getting Started](#getting-started)
20-
* [Extras](#extras)
31+
* [Special Thanks](#special-thanks)
2132
* [License](#license)
2233
* [Trilon - VueJS & Asp.NET Consulting & Training](#trilon---vue-aspnet-nodejs---consulting--training--development)
2334

@@ -33,29 +44,60 @@ _Looking for ASP.NET Core & Angular 7.x+ Universal starter? [click here](https:/
3344

3445
# Prerequisites:
3546
* [.Net Core 2.2](https://www.microsoft.com/net/download/windows)
36-
* [NodeJS](https://nodejs.org/) >= 8.9.4
47+
* [NodeJS](https://nodejs.org/) >= 10.x
3748
* [VSCode](https://code.visualstudio.com/) (ideally), or VS2017
3849

3950
# Installation:
40-
* Install the template from nuget: `dotnet new -i aspnetcore-vuejs`
4151

42-
# Getting Started:
43-
* Create folder from template: `dotnet new vuejs` ([Official documentation](https://docs.microsoft.com/en-us/dotnet/core/tools/dotnet-new?tabs=netcore2x))
52+
### Nuget | Dotnet Templates
53+
54+
Find the template through NuGet package manager inside Visual Studio or [here](https://www.nuget.org/packages/aspnetcore-vuejs)
55+
56+
> Or download it via dotnet templates
57+
58+
```ts
59+
// Make a directory where you want the project
60+
mkdir my-vue-starter && cd my-vue-starter
61+
62+
// Download the dotnet template
63+
dotnet new -i aspnetcore-vuejs
64+
65+
// Run and install the template
66+
dotnet new vuejs
67+
68+
// Make sure you install the dependencies
69+
npm install
70+
```
71+
72+
Now you can open the project via Visual Studio or VSCode, press F5 to run the application!
73+
74+
Note:
75+
76+
* This will automatically run `dotnet restore` unless you install with `dotnet new vuejs --skipRestore`
77+
* ([Official documentation](https://docs.microsoft.com/en-us/dotnet/core/tools/dotnet-new?tabs=netcore2x))
4478
* This will automatically run `dotnet restore` unless you install with `dotnet new vuejs --skipRestore`
45-
* Restore Node dependencies by running `npm install`
79+
80+
### -OR- Clone this Repo itself
81+
82+
* Clone this repository : `$ git clone https://github.com/MarkPieszak/aspnetcore-Vue-starter.git VueWeb`
83+
* `$ cd VueWeb/content`
84+
* `$ dotnet restore && npm install`
85+
* (If using VSCode) `$ code .`
86+
* (If using Visual Studio) Open the `*.sln` file with "Open project" from Visual Studio IDE
87+
4688

4789
## Start the application:
4890
You have two choices when it come at how your preffer to run it. You can either use the command line or the build-in run command.
4991

5092
### 1. Using the command line
5193
Run the application using `dotnet run` or `npm run dev`
5294
- note `dotnet run` should be run in `Development` environment for hot reloading. This setting can be set either within the command line or via the `launchSettings.json` available in the `Properties` folder.
53-
95+
5496
### 2. Using the built-in run command
5597
Run the application in VSCode or Visual Studio 2017 by hitting `F5`.
5698

5799
## View your application running
58-
Browse to [http://localhost:5000](http://localhost:5000)
100+
When running the app using debug menu or `F5` VS open auto the app in the browser;
59101

60102
# Recommended plugin for debugging VueJS
61103

@@ -68,11 +110,15 @@ Browse to [http://localhost:5000](http://localhost:5000)
68110
Nothing's ever perfect, but please let me know by creating an issue (make sure there isn't an existing one about it already), and we'll try and work out a fix for it! If you have any good ideas, or want to contribute, feel free to either make an Issue with the Proposal, or just make a PR from your Fork.
69111
Please note that this project is released with a [Contributor Covenant Code of Conduct](CODE_OF_CONDUCT.md). By participating in this project you agree to abide by its terms.
70112

113+
---
114+
115+
_Looking for ASP.NET Core & Angular 7.x+ Universal starter? [click here](https://github.com/TrilonIO/aspnetcore-angular-universal)_
116+
71117
----
72118

73119
# License
74120

75-
[![MIT License](https://img.shields.io/badge/license-MIT-blue.svg?style=flat)](/LICENSE)
121+
[![MIT License](https://img.shields.io/badge/license-MIT-blue.svg?style=for-the-badge&color=e51384)](/LICENSE)
76122

77123
Copyright (c) 2016-2019 [Mark Pieszak](https://github.com/MarkPieszak)
78124

@@ -82,13 +128,13 @@ Copyright (c) 2016-2019 [Mark Pieszak](https://github.com/MarkPieszak)
82128

83129
# Trilon - Vue, Asp.NET, NodeJS - Consulting | Training | Development
84130

85-
Check out **[Trilon.io](https://Trilon.io)** for more info! Twitter [@Trilon_io](http://www.twitter.com/Trilon_io)
131+
Check out **[Trilon.io](https://Trilon.io)** for more info!
86132

87133
Contact us at <hello@trilon.io>, and let's talk about your projects needs.
88134

89135
<p align="center">
90136
<a href="https://trilon.io" target="_blank">
91-
<img src="https://trilon.io/meta/og-image.png" alt="Trilon.io - Angular Universal, NestJS, JavaScript Application Consulting Development and Training">
137+
<img src="https://trilon.io/trilon-logo-clear.png" alt="Trilon.io - Angular Universal, NestJS, JavaScript Application Consulting Development and Training">
92138
</a>
93139
</p>
94140

0 commit comments

Comments
 (0)