From c6623509e65665f95bda20e26aec4f4a7d10ac76 Mon Sep 17 00:00:00 2001 From: Praburaj Date: Wed, 30 Jul 2014 15:56:02 -0700 Subject: [PATCH] Fixing readme with latest instructions --- README.md | 53 +++++++++++++++-------------------------------------- 1 file changed, 15 insertions(+), 38 deletions(-) diff --git a/README.md b/README.md index 3b758eb..95a823b 100644 --- a/README.md +++ b/README.md @@ -1,47 +1,24 @@ -Music store application +# MusicStore application ========= This project is part of ASP.NET vNext. You can find samples, documentation and getting started instructions for ASP.NET vNext at the [Home](https://github.com/aspnet/home) repo. -###Getting Started +### Run the application on Helios: +* Execute ```build.cmd``` to restore all the necessary packages, and run tests. +**NOTE: Tests require Visual Studio 2014 LocalDB on the machine to run. +* Open MusicStore.sln in Visual Studio 2014 and run the individual applications on ```Helios```. -The first thing we need to do is setup the tools required to build and run an application. - -* If you already have ```kvm``` installed on the machine ignore the steps below. -* Clone [Home] (https://github.com/aspnet/Home) repository -* On the command line, cd to Home repository and execute ```kvm setup``` -* This command will download the latest version of the SDK and put it on your path so that you can run the rest of the commands in the readme. If you want to know more about what this is doing then you can read the [KVM page](https://github.com/aspnet/Home/wiki/version-manager) of the wiki. -* On the command line execute ```kvm install 0.1-alpha-build-0421``` -* This command will install Desktop flavor(x86) of KRE build 0421 in your user profile -* Clone MusicStore repository, if you have not already - -### Run the application: -1. Open a command prompt and cd ```\src\\``` -2. Run ```kpm restore``` to restore all the necessary packages and generate project files - Note: ```kpm restore``` currently works only on Desktop flavor. If you intend to use Core CLR, you should get Desktop flavor, execute ```kpm restore``` and then switch to Core CLR -3. **[Helios]:** - 4. ```Helios.cmd``` to launch the app on IISExpress (Application started at URL **http://localhost:5001/**). -4. **[SelfHost]:** - 5. Run ```k web``` (Application started at URL **http://localhost:5002/**) -5. **[CustomHost]:** +### Run on WebListener/Kestrel: +* Open a command prompt and cd ```\src\MusicStore\``` +* **[Helios]:** + 4. ```Helios.cmd``` to launch the app on IISExpress from command line (Application started at URL **http://localhost:5001/**). +* **[WebListener]:** + 5. Run ```k WebListener``` (Application started at URL **http://localhost:5002/**) +* **[Kestrel]:** + 5. Run ```k Kestrel``` (Application started at URL **http://localhost:5004/**) +* **[CustomHost]:** 6. Run ```k run``` (This hosts the app in a console application - Application started at URL **http://localhost:5003/**) -### Switching between Desktop CLR and CoreCLR: -By default the app runs on desktop CLR. To switch to run the app on CoreCLR follow the steps below -* On the command line, execute ```kvm install 0.1-alpha-build-0421 -svrc50``` -* This command will install core clr flavor of KRE build 0421 and set runtime to core clr 0421 build. -* If you want to run on IIS/IISExpress against core clr, open k.ini and update KRE_FLAVOR to CORECLR and follow steps for running the application from 'Run the application' section -* If you want to run on SelfHost against core clr, follow steps for running the application from 'Run the application' section - -### Adding a new package: -1. Edit the project.json to include the package you want to install. -2. Do a ```kpm restore``` - This will restore the package in the project. - -### Work against the latest build: -1. Run ```Clean.cmd``` - This will clear all the packages and any temporary files generated -2. Continue the topic "Run the application" - ### Note: -1. Application is started on different ports on different hosts. To change the port or URL modify ```Helios.cmd``` or project.json commands section in case of self-host and customhost. - +1. Application is started on different ports on different hosts. To change the port or URL modify ```Helios.cmd``` or project.json commands section in case of self-host and customhost. \ No newline at end of file