|
1 | 1 | # ASP.NET vNext Home |
| 2 | +Latest dev version: [](https://www.myget.org/gallery/aspnetvnext)<br> |
| 3 | +Latest master version: [](https://www.myget.org/gallery/aspnetmaster) |
2 | 4 |
|
3 | | -In the next version of ASP.NET we are working with multiple teams around Microsoft to create a lean, composable .NET stack that provides a familiar and modern framework for web and cloud scenarios. |
| 5 | +The Home repository is the starting point for people to learn about ASP.NET vNext. This repo contains samples and [documentation](https://github.com/aspnet/Home/wiki) to help folks get started and learn more about what's coming in ASP.NET vNext. |
4 | 6 |
|
5 | | -The Home repository is the starting point for people to learn about ASP.NET vNext, it contains samples and [documentation](https://github.com/aspnet/Home/wiki) to help folks get started and learn more about what we are doing. |
| 7 | +ASP.NET vNext is being actively developed by the ASP.NET team assigned to the Microsoft Open Tech Hub and in collaboration with a community of open source developers. Together we are dedicated to creating the best possible platform for web development. |
6 | 8 |
|
7 | | -These products are actively developed by the ASP.NET team assigned to the Microsoft Open Tech Hub and in collaboration with a community of open source developers. Together we are dedicated to creating the best possible platform for web development. |
| 9 | +The samples provided in this repo are designed to show some of the features of the new framework and to provide a starting point for further exploration. All the component packages are available on Nuget. To try out the latest bits under development switch to the dev branch of the Home repo and use the dev feed in Nuget.config (https://www.myget.org/F/aspnetvnext). |
8 | 10 |
|
9 | | -The samples provided are designed to show some of the features of the new framework as well as setting up a sandbox for you to try out some of the new features. The NuGet.config file in the repo points to a MyGet feed (https://www.myget.org/F/aspnetvnext/) that has all the packages being developed. The feed is updated every time a full build succeeds. |
| 11 | +## Contents |
10 | 12 |
|
| 13 | +* [Minimum Requirements](#minimum-requirements) |
| 14 | +* [Getting Started](#getting-started) |
| 15 | +* [Samples](#samples) |
| 16 | +* [Documentation and Further Learning](#documentation-and-further-learning) |
| 17 | +* [Repos and Projects](#repos-and-projects) |
| 18 | +* [Feedback](#feedback) |
11 | 19 |
|
12 | | -# Minimum Requirements |
| 20 | +## Minimum Requirements |
13 | 21 |
|
14 | | -These are the current minimum requirements, they do not necesarilly represent our RTM minimum. |
| 22 | +These are the current minimum requirements for the latest preview release. They do not necessarily represent what the final minimum requirements will be. |
15 | 23 |
|
16 | 24 | ### Windows |
17 | | -* Windows 7 or greater, though Core CLR will only work on Windows 8 today. If using Core CLR you will need to be on Windows 8 or above. At RTM the whole stack will support Windows 7+ and Windows Server 2008 R2+. |
| 25 | +* Windows 7 or Windows Server 2008 R2. |
18 | 26 | * .NET 4.5.1 for hosting in IIS |
19 | 27 |
|
20 | | -### OSX/Linux |
21 | | - * Mono >= 3.4.1 - Currently this means compiling Mono from source from https://github.com/mono/mono (Note: See instructions below to install the Homebrew formula that can install the required mono) |
22 | | - * On Linux, you may need to run `mozroots --import --sync` after installing mono |
| 28 | +### OS X/Linux |
| 29 | + * Mono 3.4.1 or later (Note: On OS X use the Homebrew formula specified below to install the required version of Mono) |
23 | 30 | * bash or zsh and curl |
24 | 31 |
|
25 | | -#Getting Started |
| 32 | +## Getting Started |
26 | 33 |
|
27 | | -The first thing we need to do is setup the tools required to build and run an application. We will start out by getting the [K Version Manager (KVM)](https://github.com/aspnet/Home/wiki/version-manager) |
| 34 | +The easiest way to get started with ASP.NET vNext is to try out the latest preview of Visual Studio 2015 Preview. You can find installation instructions and getting started documentation at http://www.asp.net/vnext. |
28 | 35 |
|
29 | | -The easiest way to get the KVM on Windows is to run the following command: |
30 | | -```powershell |
31 | | -@powershell -NoProfile -ExecutionPolicy unrestricted -Command "iex ((new-object net.webclient).DownloadString('https://raw.githubusercontent.com/aspnet/Home/master/kvminstall.ps1'))" |
32 | | -``` |
33 | | -or on OSX: |
| 36 | +That said, you can also try out ASP.NET vNext with just a command-prompt and a text editor. The following instructions will walk you through getting your dev environment setup. |
| 37 | + |
| 38 | +### Install the K Version Manager (KVM) |
| 39 | + |
| 40 | +The first thing we need to do is setup the tools required to build and run an application. We will start out by getting the [K Version Manager (KVM)](https://github.com/aspnet/Home/wiki/version-manager). You use the K Version Manager to install different versions of the ASP.NET vNext runtime and switch between them. |
| 41 | + |
| 42 | +#### Windows |
| 43 | +To install KVM on Windows run the following command, which will download and run a script that installs KVM for the current user (requires admin privileges): |
| 44 | + |
| 45 | +*@powershell -NoProfile -ExecutionPolicy unrestricted -Command "iex ((new-object net.webclient).DownloadString('https://raw.githubusercontent.com/aspnet/Home/master/kvminstall.ps1'))"* |
| 46 | + |
| 47 | +After the script has run open a new command prompt to start using KVM. |
34 | 48 |
|
35 | | -Mono and KVM (K Version manager) required to develop & run next generation ASP.NET applications on OSX is available as a Homebrew formula. To install the necessary development tools: |
| 49 | +#### OS X: |
36 | 50 |
|
37 | | - * Open a terminal on your MAC |
38 | | - * Install [Homebrew](http://brew.sh) by running the following command. If you already have Homebrew installed skip this step. |
39 | | -```ruby -e "$(curl -fsSL https://raw.github.com/Homebrew/homebrew/go/install)"``` |
40 | | - * Run command `brew tap aspnet/k` to tap the aspnet vnext related git repositories. |
41 | | - * Run command `brew install kvm` to install KVM. This also automatically install the latest KRE package from https://www.myget.org/f/aspnetvnext/api/v2 feed. |
| 51 | +To install KVM and the correct version of Mono on OS X using [Homebrew](http://brew.sh) follow the following steps: |
42 | 52 |
|
43 | | -Now you are set for developing next general ASP.NET applications on OSX. A few things to note: |
44 | | - * If you would like to use a different KRE version for your development, you can install the desired version using KVM. See [KVM page](https://github.com/aspnet/Home/wiki/version-manager) for more information. |
| 53 | + * Install [Homebrew](http://brew.sh) if it is not already installed. |
| 54 | + * Run command `brew tap aspnet/k` to tap the ASP.NET vNext related git repositories. If you had already tapped the repo for previous releases, run `brew untap aspnet/k` to delete the old commands and tap again to get the updated brew scripts. |
| 55 | + * Run command `brew install kvm` to install KVM. This also automatically install the latest KRE package from https://www.myget.org/f/aspnetmaster/api/v2 feed. |
45 | 56 | * Run command `source kvm.sh` on your terminal if your terminal cannot understand kvm. |
46 | 57 |
|
47 | | -or on Linux: |
| 58 | +#### Linux: |
| 59 | + |
| 60 | +To install KVM on Linux run the following command: |
| 61 | + |
48 | 62 | ``` |
49 | 63 | curl https://raw.githubusercontent.com/aspnet/Home/master/kvminstall.sh | sh && source ~/.kre/kvm/kvm.sh |
50 | 64 | ``` |
51 | 65 |
|
52 | | -This downloads KVM from this repository and puts it on your machine. Alternatively, you you could clone the repo and get it: |
53 | | -* Clone the repository |
54 | | -* On the command line execute |
55 | | - * ```kvm setup``` on Windows or |
56 | | - * ```sh kvminstall.sh && source ~/.kre/kvm/kvm.sh``` on OSX/Linux |
57 | | - |
58 | | -This command will setup your environment, getting it ready to install a version of the runtime. It adds KVM to your path and puts it in your user profile. Once you have KVM then you need to get a version of the runtime: |
59 | | -* Execute ```kvm install 0.1-alpha-build-0446```. This command will download the named version of the KRE and put it on your user profile ready to use. You can get the latest version by running ```kvm upgrade``` but 0446 was the last version explicitly tested. see the [KVM page](https://github.com/aspnet/Home/wiki/version-manager) for more information on KVM. |
60 | | -* Navigate to samples\ConsoleApp |
61 | | -* Run ```kpm restore```. This downloads the System.Console package so the app can do Console.WriteLine |
62 | | -* Run ```k run``` |
63 | | -* You should see a message saying "Hello World" |
64 | | -* Type |
65 | | - * ```SET KRE_TRACE=1``` on Windows or |
66 | | - * ```export KRE_TRACE=1``` on OSX/Linux |
67 | | -* Run ```k run``` |
68 | | -* You should now see compiler output as well as the "Hello World" message |
| 66 | +Note that on Linux you need to also install [Mono](http://mono-project.com) 3.4.1 or later. |
69 | 67 |
|
70 | | -``` |
71 | | -:: getting started |
72 | | -git clone https://github.com/aspnet/Home.git |
73 | | -cd Home |
74 | | -kvm setup |
75 | | -kvm install 0.1-alpha-build-0446 -p |
76 | | -
|
77 | | -cd samples\ConsoleApp |
78 | | -kpm restore |
79 | | -k run |
80 | | -
|
81 | | -SET KRE_TRACE=1 |
82 | | -k run |
83 | | -``` |
| 68 | +### Install the K Runtime Environment (KRE) |
84 | 69 |
|
85 | | -# Samples |
| 70 | +Now that you have KVM setup you can install the latest version of the runtime by running the following command: ```kvm upgrade``` |
| 71 | + |
| 72 | +This command will download the specified version of the K Runtime Environment (KRE), and put it on your user profile ready to use. You are now ready to start using ASP.NET vNext! |
86 | 73 |
|
87 | | -## Sandbox Samples |
| 74 | +## Samples |
88 | 75 |
|
89 | | -These samples, in this repo, are just basic starting points for you to experiment with features. Since there is no File->New Project we thought some simple samples to take the place of scaffolding would be convenient. |
| 76 | +The samples in this repo are basic starting points for you to experiment with. |
90 | 77 |
|
91 | 78 | + [ConsoleApp](https://github.com/aspnet/Home/tree/master/samples/ConsoleApp). This is just basic console app if you want to use it as a starting point. |
92 | 79 | + [HelloWeb](https://github.com/aspnet/Home/tree/master/samples/HelloWeb). This is a minimal startup class that shows welcome page and static file middleware. This is mostly for you to run through the steps in the readme and make sure you have everything setup and working correctly. |
93 | 80 | + [HelloMvc](https://github.com/aspnet/Home/tree/master/samples/HelloMvc). This sample is a basic MVC app. It is not designed to show all the functionality of the new web stack, but to give you a starting point to play with features. |
| 81 | ++ [MVC Music Store](https://github.com/aspnet/MusicStore) and [BugTracker](https://github.com/aspnet/BugTracker) are application samples that are both being ported to ASP.NET vNext. Each of these samples have their own separate repositories that you can look at. |
94 | 82 |
|
95 | | -**NOTE: The samples are pinned to a specific version of the packages. If you want to try the latest builds then update the project.json and replace the last part of the version with a '\*', so '0.1-alpha-build-267' becomes '0.1-alpha-\*', and then run ```kpm restore``` to pull down the latest packages** |
| 83 | +### Running the samples |
96 | 84 |
|
97 | | -## Feature Samples |
98 | | -The [Entropy repo](https://github.com/aspnet/Entropy) contains samples of specific features in isolation. Each directory contains just enough code to show an aspect of a feature. |
| 85 | +1. Clone the Home repository |
| 86 | +2. Change directory to the folder of the sample you want to run |
| 87 | +3. Run ```kpm restore``` to restore the packages required by that sample. |
| 88 | +4. You should see a bunch of output as all the dependencies of the app are downloaded from MyGet. |
| 89 | +5. Run the sample using the appropriate K command: |
| 90 | + - For the console app run ```k run```. |
| 91 | + - For the web apps run ```k web``` on Windows or ```k kestrel``` on Mono. |
| 92 | +6. You should see the output of the console app or a message that says the site is now started. |
| 93 | +7. You can navigate to the web apps in a browser by going to "http://localhost:5001" or "http://localhost:5004" if running on Mono. |
99 | 94 |
|
100 | | -## Application Samples |
101 | | -[MVC Music Store](https://github.com/aspnet/MusicStore) and [BugTracker](https://github.com/aspnet/BugTracker) application are both being ported. Each of these have their own repository that you can look at. |
| 95 | +### Switching to Core CLR |
102 | 96 |
|
103 | | -# Running the samples |
| 97 | +By default when running ASP.NET vNext applications on the Windows platform you are running on the full .NET Framework. You can switch to use the new Cloud Optimized runtime, or Core CLR, using the KVM command. |
104 | 98 |
|
105 | | -## Running HelloWeb |
| 99 | +1. Run ```kvm upgrade -runtime CoreCLR``` This command gets the latest Core CLR version of the k runtime and sets it as your default. The `-runtime CoreCLR` switch tells it to use Core CLR. You can use `-r CLR` to target desktop again. |
| 100 | +2. Run ```k web``` to run on WebListener. |
| 101 | +3. The first line of your output should say "Loaded Module: klr.core45.dll" instead of "Loaded Module: klr.net45.dll" |
| 102 | +4. The HelloWeb app should work the same as when running on the full desktop .NET Framework but now as a fully self-contained app with true side-by-side versioning support. |
106 | 103 |
|
107 | | -1. Clone the repository |
108 | | -2. Change directory to Samples\HelloWeb |
109 | | -3. Run ```kpm restore``` |
110 | | -4. You should see a bunch of output as all the dependencies of the app are downloaded from MyGet. The K commands all operate on the app that is in the current directory. |
111 | | -5. Run ```K web``` to run on WebListener. Or run ```K Kestrel``` to run on Mono. |
112 | | -6. You should see build output and a message to show the site is now started |
113 | | -7. Navigate to "http://localhost:5001" or "http://localhost:5004" in case of Mono |
114 | | -8. You should see the welcome page |
115 | | -9. Navigate to "http://localhost:5001/image.jpg" or "http://localhost:5004/image.img" in case of Mono. |
116 | | -10. You should see an image served with the static file middleware |
| 104 | +**NOTE: There are many APIs from the .NET Framework that are not yet available when running on Core CLR. This set should get smaller and smaller as time goes on.** |
117 | 105 |
|
118 | | -If you can do all of the above then everything should be working. You can try out the WebFx sample now to see some more of the new stack. You should run ```kpm restore``` before using any sample for the first time. |
| 106 | +**NOTE: There is no Core CLR currently available on OSX/Linux. There is only a single platform (mono45) and a single architecture (x86).** |
119 | 107 |
|
120 | | -# Switching to Core CLR |
| 108 | +## Documentation and Further Learning |
121 | 109 |
|
| 110 | +### [Community Standup](http://www.youtube.com/playlist?list=PL0M0zPgJ3HSftTAAHttA3JQU4vOjXFquF) |
| 111 | +The community standup is held every week and streamed live to YouTube. You can view past standups in the linked playlist. |
122 | 112 |
|
123 | | -By default when running the applications you are running against Desktop CLR (4.5), you can change that using the KVM command. |
| 113 | +If you have questions you can also jump online during the next standup and have them answered live. |
124 | 114 |
|
125 | | -1. Run ```kvm install 0.1-alpha-build-0446 -svrc50``` This command gets the latest Core CLR version of the k runtime and sets it as your default. The -svrc50 switch tells it to use Core CLR, you can use -svr50 to target desktop again. |
126 | | -2. Run ```K web``` to run on WebListener. Or run ```K Kestrel``` to run on Mono. |
127 | | -3. The first line of your output should say "Loaded Module: klr.core45.dll" instead of "Loaded Module: klr.net45.dll" |
128 | | -4. The HelloWeb app should work the same as when running on Desktop CLR. |
| 115 | +### [Wiki Documentation] (https://github.com/aspnet/Home/wiki) |
| 116 | +We have some useful documentation on the wiki of this Repo. This wiki is a central spot for docs from any part of the stack. |
129 | 117 |
|
130 | | -**NOTE: There are going to be parts of the stack that work on Desktop but do not work on Core CLR. This set should get smaller and smaller as time goes on, but it is entirely likely as you use Core CLR you will hit errors that can't be worked around as the Core CLR surface area just does not exist yet.** |
| 118 | +If you see errors, or want some extra content, then feel free to create an issue or send a pull request (see feedback section below). |
131 | 119 |
|
132 | | -**NOTE: There is no Core CLR currently on OSX/Linux. There is only a single platform (mono45) and a single architecture (x86).** |
| 120 | +### [ASP.NET/vNext](http://www.asp.net/vnext) |
| 121 | +The vNext page on the ASP.NET site has links to some TechEd videos and articles with some good information about vNext. |
133 | 122 |
|
134 | | -#Core CLR Packages |
| 123 | +## Repos and Projects |
135 | 124 |
|
136 | | -Currently the BCL is split into some fairly fine grained packages, which was one of the goals of this effort. However, the packages that exist today do not necessarily represent the list of packages that we will end up with. We are still experimenting with what makes sense to be a package and what the experience should be. |
| 125 | +These are some of the most common repos: |
137 | 126 |
|
138 | | -# Known Issues |
| 127 | +* [DependencyInjection](https://github.com/aspnet/DependencyInjection) - basic dependency injection infrastructure and default implementation |
| 128 | +* [EntityFramework](https://github.com/aspnet/EntityFramework) - data access technology |
| 129 | +* [Identity](https://github.com/aspnet/Identity) - users and membership system |
| 130 | +* [KRuntime](https://github.com/aspnet/KRuntime) - core runtime, project system, loader |
| 131 | +* [MVC](https://github.com/aspnet/Mvc) - MVC framework for web apps and services |
| 132 | +* [SignalR-Server](https://github.com/aspnet/SignalR-Server) - real-time |
139 | 133 |
|
140 | | -* Core CLR doesn't currently work on Windows OSes earlier than Windows 8 |
| 134 | +A description of all the repos is [here](https://github.com/aspnet/Home/wiki/Repo-List). |
141 | 135 |
|
142 | | -# Feedback |
| 136 | +## Feedback |
143 | 137 |
|
144 | 138 | Check out the [contributing](https://github.com/aspnet/Home/blob/master/CONTRIBUTING.md) page to see the best places to log issues and start discussions. |
0 commit comments