Aspnet Starter Kit

Overview:

ASP.NET Core Starter Kit is a real-world boilerplate and tooling for creating single-page web applications (SPA) oriented towards progressive enhancement design, cross-platform compatibility, and component-based UI architecture. It is built upon best of breed technologies including .NET Core, Kestrel, EF Core, Babel, Webpack, React, Redux, CSS Modules, React Hot Loader and more. It is available in both C# and F# flavors.

Features:

• Component-based front-end development via Webpack, CSS Modules, and React
• Modern JavaScript syntax (ES2015+) via Babel; modern CSS syntax (CSS3+) via PostCSS
• Application state management via Redux
• Universal cross-stack routing and navigation via path-to-regexp and history
• Code-splitting and async chunk loading with Webpack and ES6 System.import()
• Hot Module Replacement (HMR) with React Hot Loader
• Lightweight build automation with plain JavaScript
• Cross-device testing with Browsersync
• Git-based deployment to Azure App Service
• 24/7 community support on Gitter or StackOverflow; consulting and customization requests on Codementor

Installation:

Prerequisites:

• OS X, Windows or Linux
• Node.js v6 or newer
• .NET Core and .NET Core SDK
• Visual Studio Code with C# extension (or Visual Studio 2015 or newer)

Getting Started: Step 1. Clone the latest version of ASP.NET Core Starter Kit on your local machine by running:

git clone https://github.com/kriasoft/aspnet-starter-kit.git MyApp
cd MyApp

Alternatively, scaffold your project with Yeoman:

npm install -g yo generator-aspnetcore-spa
yo aspnetcore-spa

Step 2. Install project dependencies listed in project.json and package.json files:

npm install
dotnet restore

Step 3. Finally, launch your web app:

npm start

The app should become available at http://localhost:5000/. See run.js for other available commands such as node run build, node run publish, etc. You can also run your app in a release (production) mode by running node run --release, or without Hot Module Replacement (HMR) by running node run --no-hmr.

How to Deploy: Before you can deploy your app to Azure App Service, you need to open Web App settings in Azure Portal, go to “Deployment Source”, select “Local Git Repository” and hit OK. Then copy and paste “Git clone URL” of your Web App into run.js/publish file. Finally, whenever you need to compile your app into a distributable format and upload that to Windows Azure App Service, simply run node run publish.

How to Update: We work hard on keeping the project up-to-date and adding new features. Down the road, after starting a new web application project based on this boilerplate, you can always fetch and merge the latest changes from this (upstream) repo back into your project by running:

git remote add upstream https://github.com/kriasoft/aspnet-starter-kit.git
git fetch upstream
git merge upstream/master

Alternatively, pull the latest version of this repository into a separate folder and compare it with your project using a diff tool such as Beyond Compare.

How to Contribute: Anyone and everyone is welcome to contribute to the project.