Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bbaia/connect-owin
Node.js connect middleware for .NET using OWIN
https://github.com/bbaia/connect-owin
c-sharp connect-middlewares dotnet expressjs net-owin-middlewares owin
Last synced: 4 days ago
JSON representation
Node.js connect middleware for .NET using OWIN
- Host: GitHub
- URL: https://github.com/bbaia/connect-owin
- Owner: bbaia
- License: apache-2.0
- Created: 2013-09-09T22:40:13.000Z (about 11 years ago)
- Default Branch: master
- Last Pushed: 2017-07-19T09:14:25.000Z (over 7 years ago)
- Last Synced: 2024-04-24T03:23:14.014Z (7 months ago)
- Topics: c-sharp, connect-middlewares, dotnet, expressjs, net-owin-middlewares, owin
- Language: C#
- Homepage:
- Size: 794 KB
- Stars: 46
- Watchers: 5
- Forks: 6
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: HISTORY.md
Awesome Lists containing this project
README
# [connect-owin](https://github.com/bbaia/connect-owin/) [](https://travis-ci.org/bbaia/connect-owin)
Implement node.js [connect middleware](http://www.senchalabs.org/connect/) in .NET using [OWIN](http://owin.org/).
Versions are incremented according to [semver](http://semver.org/).
This is a fork of Tomasz Janczuk's [original code](https://github.com/bbaia/edge-connect/);
thanks go to him for getting this thing started!
## Introduction
OWIN itself is not a technology, just a specification to decouple Web applications from the Web server.
The goal of `connect-owin` is to implement this specification to use `node.js`, through `connect` framework, as the Web Server.
The `connect-owin` exports a function that returns a connect middleware.
The function takes the path of the OWIN .NET assembly file as a parameter.
The following code shows how to use `connect-owin` with [express.js](http://expressjs.com/),
a Web framework built on connect:
```js
var owin = require('connect-owin'),
express = require('express');
var app = express();
app.all('/net', owin('MyAssembly.dll'));
// ...
app.listen(3000);
```
.NET OWIN middlewares can be implemented in two ways with `connect-owin`:
* By implementing the OWIN primary interface `Func, Task>`:
```csharp
public class Startup
{
public Task Invoke(IDictionary env)
{
// ...
}
}
```
* By using the `IAppBuilder` interface that acts as the glue for any .NET OWIN middleware, exactly how connect in node.js works:
```csharp
public class Startup
{
public void Configuration(IAppBuilder builder)
{
// ...
}
}
```
The `connect-owin` function uses `.Startup` as default type name, and `Configuration` as default method name.
Custom type and method name can be provided via an options object:
```js
owin({
assemblyFile: 'MyAssembly.dll',
typeName: 'MyNamespace.MyType',
methodName: 'MyMethodName'
});
```
## Requirements
* Windows, Linux or MacOS
* [node.js](http://nodejs.org/) 0.8.x or later
* [.NET Framework 4.5](http://www.microsoft.com/en-us/download/details.aspx?id=30653) or [Mono 3.4](http://www.mono-project.com/)
## Building
[Grunt](http://gruntjs.com/) is used to build, test and preview the sample on all platforms.
First, install `connect-owin` dependencies:
$ npm install
Then, you'll need to install Grunt's command line interface (CLI) globally:
$ npm install -g grunt-cli
You can build sources, run tests and preview the sample by using the default Grunt task:
$ grunt
### Building sources
$ grunt build
The build creates the `lib\clr\Connect.Owin.dll` file required by the `lib\connect-owin.js` library.
### Running the sample
_Using Grunt_
The following command uses the `grunt-contrib-connect` task to start a `connect` web server
with the .NET OWIN application plugged in as a middleware and open the page in your default browser:
$ grunt hello
_Using express.js_
An [express.js](http://expressjs.com/) sample is also provided to run the .NET OWIN application:
$ cd examples\hello
$ npm install express
$ node server.js
Then go to http://localhost:3000/node. This should display a message from an express middleware in node.js.
If you go to http://localhost:3000/net, you should see a similar message from the .NET OWIN application
in `Owin.Connect.Examples.Hello.dll` plugged in as a middleware to the express pipeline.
_Using webpack-dev-server_
A [webpack](https://webpack.github.io/) sample is also provided to allow
the `webpack` development server to serve your .NET OWIN application:
$ npm install -g webpack
$ npm install -g webpack-dev-server
$ webpack-dev-server --config webpack.config.js
Then go to http://localhost:8080/net. This should display a message from the .NET OWIN application.
_More samples available @ [connect-owin-samples](https://github.com/bbaia/connect-owin-samples/)_
### Running tests
$ grunt test
`mocha` is used to run tests.