microsoft/dotnet-apiweb

Website to display data gathered by the Microsoft ApiPort tool

.NET Portability Analyzer Website

This repository contains the source code for the .NET Portability website.

Today, the repository contains the following components:

• DotNetStatus. An ASP.NET 5 implementation of .NET Portability site.

Using this Repository

1. Install the following:
   1. Visual Studio 2015
   2. .NET Version Manager (DNVM)
   3. .NET Execution Environment (DNX)

Windows

Building/Running from Commandline

1. Go to src\DotNetStatus
2. Run command: dnu restore
3. Run command: dnx . web
4. The website should be started on http://localhost:5000

Building/Running from Visual Studio

1. Open DotNetStatus.sln

2. Check that all the Dependencies have loaded (like NPM and Bower) and packages were restored

   • Check the Output window -> Package Manager Log to make sure that everything was successful

3. There are two targets you can run/debug with:

   • IIS Express
   • web - To run on DNX

   These can be found under the Project Properties -> Debug or by clicking the drop-down menu on the Debug button in your main toolbar.

4. You can also change the Target DNX Version (ex. so that it runs on .NET Core) by:

   • Go to Project Properties -> Application
   • Check off "Use specific DNX version"
   • Change the Platform from .NET Framework to .NET Core

Troubleshooting

1. dnu restore outputs: Error: ENOENT, stat 'C:\Users\CurrentUser\AppData\Roaming\npm'
   • Execute: mkdir %APPDATA%\npm (Command Prompt) or mkdir $env:AppData\npm (Powershell)
   • Execute: dnu restore
2. dnu restore outputs: 'grunt' is not recognized as an internal or external command
   • Execute: npm install -g grunt-cli
   • Execute: dnu restore

Linux

Building/Running on Ubuntu

1. Go to src/DotNetStatus
2. Install npm
   • sudo apt-get update
   • sudo apt-get install nodejs
   • sudo apt-get install npm
3. Install Grunt globally
   • sudo npm install -g grunt-cli
4. dnu restore
5. cd src/DotNetStatus
6. grunt
7. Run the site: dnx . kestrel

Troubleshooting

1. dnu restore cannot find Microsoft.Fx.Portability
   • Open ~/.config/NuGet/NuGet.config in a text editor
   • Add <add key="dotnet-apiport" value="https://www.myget.org/F/dotnet-apiport" /> under <packageSources>
   • Try again

How to Engage, Contribute and Provide Feedback

Some of the best ways to contribute are to try things out, file bugs, and join in design conversations.

Want to get more familiar with what's going on in the code?

• Pull requests: Open/Closed

Looking for something to work on? The list of up-for-grabs issues is a great place to start.

We're re-using the same contributing approach as .NET Core. You can check out the .NET Core contributing guide at the corefx repo wiki for more details.

• How to Contribute
  • Contributing Guide
  • Developer Guide

You are also encouraged to start a discussion on the .NET Foundation forums!

Related Projects

For an overview of all the .NET related projects, have a look at the .NET home repository.

License

This project is licensed under the MIT license.

dotnet-apiweb's Issues

Add API search support to dotnetstatus site

From @dsplaisted on November 5, 2015 19:55

Right now there is a "search" box with autocomplete. If you type (or use autocomplete to get) the full name of the API, then you can navigate to the page for that API. But there's no search results page and no way to search using a partial name.

We should:

• Add a search results page
• Support searching for partial names
• Show types in the search results in addition to members

Copied from original issue: microsoft/dotnet-apiport#181

API details page should make it easy to add / edit recommended changes

From @dsplaisted on November 5, 2015 20:6

If I look up an API that's not available on .NET Core and it doesn't have any recommended changes, I should be able to easily add information about what to replace it with. Ideally the recommended changes would be stored in a GitHub repo, and the API details page could include a link that would start a pull request to add recommended changes for the API.

Copied from original issue: microsoft/dotnet-apiport#183

Show the contract that an API belongs to

From @dsplaisted on November 5, 2015 19:57

The page that shows details for an API should show which contract it is included in. This will tell people which NuGet package they need to reference in .NET Core projects in order to use the API.

Copied from original issue: microsoft/dotnet-apiport#182