Yeoman generator for ASP.NET vNext projects
- Dependencies:
- node.js:
brew install nodefor OSX,choco install nodefor Windows - Yeoman:
npm install -g yo
- node.js:
- Install:
npm install -g generator-aspnet - Run:
yo aspnet
-
yo aspnetshows a wizard for generating a new ASP.NET app -
yo aspnet --gruntgenerates Gruntfile.js files for web template instead of gulp.js -
yo aspnet --helpshows flags and other configurable options
Full, template based projects available in generator:
- Empty Application
- Console Application
- Web Application
- Web Application Basic [without Membership and Authorization]
- Web API Application
- Nancy ASP.NET Application
- Class Library
The Empty Application, Web Application, Web Application Basic (a.k.a. Web Application No Auth), Web API Application are based on the new templates recently introduced with Visual Studio 2015 RC release, with updates for beta5. You can read about these new templates on the blog post accompanying the beta5 release:
Updates to ASP.NET 5 yeoman generators for beta 5
The Nancy project is based on framework's "Hello World" template: Nancy Getting Started: Introduction
The goal of generator-aspnet is to provide an experience consistent with creating new ASP.NET 5 (DNX) projects
and files in Visual Studio 2015. Below are some other related generators that you may be interested in.
generator-csharp is a work in progress but is available for you to try out today. The goal of generator-csharp is to provide an experience consistent with creating C# projects (MSBuild based, not DNX) and files in Visual Studio 2015.
generator-aspnet-xtianus is an extension of OmniSharp/generator-aspnet that comes with a special Foundation 5 SASS/SCSS framework ready out of the box with wiredep & other grunt tasks for advanced front-end development. Look for => Starter Web Application - Foundation 5. The other goal of this generator is to provide alternative templates to the traditional ASP.NET Visual Studio templates. More templates will become housed under this fork in the near future. Feel free to participate and learn more about generator-aspnet-xtianus.
If you are working on a related generator please open an issue to let us know about it so that we can add it to the list.
Available sub generators (to create files after the project has been created):
- aspnet:MvcController
- aspnet:MvcView
- aspnet:WebApiContoller
- aspnet:AngularModule
- aspnet:AngularController
- aspnet:AngularControllerAs
- aspnet:AngularDirective
- aspnet:AngularFactory
- aspnet:Class
- aspnet:Interface
- aspnet:StartupClass
- aspnet:BowerJson
- aspnet:CoffeeScript
- aspnet:Config
- aspnet:Gulpfile
- aspnet:Gruntfile
- aspnet:gitignore
- aspnet:HTMLPage
- aspnet:JavaScript
- aspnet:JScript
- aspnet:JSON
- aspnet:JSONSchema
- aspnet:JSX
- aspnet:Middleware
- aspnet:PackageJson
- aspnet:StyleSheet
- aspnet:StyleSheetScss
- aspnet:StyleSheetLess
- aspnet:TagHelper
- aspnet:TextFile
- aspnet:TypeScript
- aspnet:TypeScriptConfig
** Note: files generated are created in the working directory, no conventions are forced **
Creates a new ASP.NET 5 MvcController class
Example:
yo aspnet:MvcController ContactController
Produces /ContactController.cs
using Microsoft.AspNet.Mvc;
// For more information on enabling MVC for empty projects, visit http://go.microsoft.com/fwlink/?LinkID=397860
namespace MyNamespace
{
public class ContactController : Controller
{
// GET: /<controller>/
public IActionResult Index()
{
return View();
}
}
}Creates a new ASP.NET 5 MvcView page file
Example:
yo aspnet:MvcView ContactView
Produces /ContactView.cshtml
@*
For more information on enabling MVC for empty projects, visit http://go.microsoft.com/fwlink/?LinkID=397860
*@
@{
// ViewBag.Title = "ContactView Page";
}
Creates a new ASP.NET 5 WebApiController class
Example:
yo aspnet:WebApiController ValuesController
Produces /ValuesController.cs
using System;
using System.Collections.Generic;
using System.Linq;
using Microsoft.AspNet.Mvc;
// For more information on enabling Web API for empty projects, visit http://go.microsoft.com/fwlink/?LinkID=397860
namespace MyNamespace.Controllers
{
[Route("api/[controller]")]
public class ValuesController : Controller
{
// GET: api/values
[HttpGet]
public IEnumerable<string> Get()
{
return new string[] { "value1", "value2" };
}
// GET api/values/5
[HttpGet("{id}")]
public string Get(int id)
{
return "value";
}
// POST api/values
[HttpPost]
public void Post([FromBody]string value)
{
}
// PUT api/values/5
[HttpPut("{id}")]
public void Put(int id, [FromBody]string value)
{
}
// DELETE api/values/5
[HttpDelete("{id}")]
public void Delete(int id)
{
}
}
}Creates AngularJS module file
Example:
yo aspnet:AngularModule filename
Produces filename.js
Creates AngularJS controller file using $scope
Example:
yo aspnet:AngularController filename
Produces filename.js
Creates AngularJS controller file using Controller As syntax.
Example:
yo aspnet:AngularControllerAs filename
Produces filename.js
Creates AngularJS directive file.
Example:
yo aspnet:AngularDirective filename
Produces filename.js
Creates AngularJS factory file.
Example:
yo aspnet:AngularFactory filename
Produces filename.js
Creates a new ASP.NET 5 Class
Example:
yo aspnet:Class Contact
Produces /Contact.cs
using System;
namespace MyNamespace
{
public class Contact
{
}
}Creates a new ASP.NET 5 Interface
Example:
yo aspnet:Interface IContact
Produces /IContact.cs
Creates a new Startup Class file
Example:
yo aspnet:StartupClass
Produces Startup.cs
Creates a new bower.json and configuration file.
Example:
yo aspnet:BowerJson
Produces bower.json and .bowerrc
Creates a new CoffeeScript file
Example:
yo aspnet:CoffeeScript filename
Produces filename.coffee
Creates a new config.json file
Example:
yo aspnet:Config
Produces config.json
Creates a new Gulp file
Example:
yo aspnet:Gulpfile
Produces gulpfile.js
Creates a new Grunt file
Example:
yo aspnet:Gruntfile
Produces Gruntfile.js
Creates a new .gitignore file
Example:
yo aspnet:gitignore
Produces .gitignore
Creates a new HTML file
Example:
yo aspnet:HTMLPage filename
Produces filename.html
Creates a new JavaScript file
Example:
yo aspnet:JavaScript filename
Produces filename.js
Creates a new JavaScript file
Example:
yo aspnet:JScript filename
Produces filename.js
Creates a new JSON file
Example:
yo aspnet:JSON filename
Produces filename.json
Creates a new JSON schema file
Example:
yo aspnet:JSONSchema filename
Produces filename.json
Creates a new React JSX file
Example:
yo aspnet:JSX filename
Produces filename.jsx
Creates a new C# Middleware class file
Example:
yo aspnet:Middleware filename
Produces filename.cs
Creates a new package.json file
Example:
yo aspnet:PackageJson
Produces package.json
Creates a new CSS file
Example:
yo aspnet:StyleSheet style
Produces style.css
Creates a new Less class file
Example:
yo aspnet:StyleSheetLess filename
Produces filename.less
Creates a new Sass SCSS class file
Example:
yo aspnet:StyleSheetSCSS filename
Produces filename.scss
Creates a new TagHelper class file
Example:
yo aspnet:TagHelper filename
Produces filename.cs
Creates a new Text file
Example:
yo aspnet:TextFile filename
Produces filename.txt
Creates a new TypeScript file
Example:
yo aspnet:TypeScript filename
Produces filename.ts
Creates a new TypeScript configuration file
Example:
yo aspnet:TypeScriptConfig
Produces tsconfig.json
Copyright 2014-2015 OmniSharp
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent