C# Shell PowerShell Batchfile JavaScript CSS

README.md

Bridge.NET logo

Build status Build Status NuGet Status Join the chat at https://gitter.im/bridgedotnet/Bridge

Bridge.NET is an open source C#-to-JavaScript Compiler. Write your application in C# and run on billions of devices.

Write in C#. Run in a Web Browser.

C#JavaScript
public class Program
{
    public static void Main()
    {
        var msg = "Hello, World!";
        Console.WriteLine(msg);
    }

}

Bridge.define("Demo.Program", {
    main: function Main () {
        var msg = "Hello, World!";
        System.Console.WriteLine(msg);
    }

});

Run the sample above at Deck.NET.

TL;DR

Getting Started

A great place to start if you're new to Bridge is reviewing the Getting Started wiki.

The easiest place to see Bridge in action is Deck.NET.

Video Tutorial

Sample

The following code sample demonstrates a simple App.cs class that will run automatically on page load and write a message to the Bridge Console.

Example (Deck)

public class Program
{
    public static void Main()
    {
        Console.WriteLine("Hello World!");
    }
}

The C# class above will be compiled into JavaScript and added to /Bridge/ouput/demo.js within your project. By default, Bridge will use the Namespace name as the file name. In this case: demo.js. There are many options to control the output of your JavaScript files, and the Attribute Reference is important documentation to review.

Bridge.define("Demo.Program", {
    main: function Main() {
        System.Console.WriteLine("Hello World!");
    }
});

Installation

A full list of installation options available at bridge.net/download/, including full support for Visual Studio and Visual Studio Community on Windows, and Visual Studio Mac.

Bridge for Visual Studio

If you're using Visual Studio for Windows, the easiest way to get started is by adding the Bridge.NET for Visual Studio extension.

From within Visual Studio, go to the Tools > Extensions and Updates....

Bridge for Visual Studio

From the options on the left side, be sure to select Online, then search for Bridge. Clicking Download will install Bridge for Visual Studio. After installation is complete, Visual Studio may require a restart.

Visual Studio Extensions and Updates

Once installation is complete you will have a new Bridge.NET project type. When creating new Bridge enabled projects, select this project type.

NuGet

Another option is installation of Bridge into a new C# Class Library project using NuGet. Within the NuGet Package Manager, search for Bridge and click to install.

Bridge can also be installed using the NuGet Command Line tool by running the following command:

Install-Package Bridge

More information regarding Nuget package installation for Bridge is available in the Documentation.

Contributing

Interested in contributing to Bridge? Please see CONTRIBUTING.md.

We also flag some Issues as up-for-grabs. These are generally easy introductions to the inner workings of Bridge, and are items we just haven't had time to implement. Your help is always appreciated.

Badges

Show your support by adding a built with Bridge.NET badge to your projects README or website.

Built with Bridge.NET

Markdown

[![Built with Bridge.NET](https://img.shields.io/badge/built%20with-Bridge.NET-blue.svg)](http://bridge.net/)

HTML

<a href="http://bridge.net/">
    <img src="https://img.shields.io/badge/built%20with-Bridge.NET-blue.svg" title="Built with Bridge.NET" />
</a>

How to Help

We need your help spreading the word about Bridge. Any of the following items will help:

  1. Star the Bridge project on GitHub
  2. Add a Badge
  3. Leave a review at Visual Studio Gallery
  4. Blog about Bridge.NET
  5. Tweet about @bridgedotnet
  6. Start a discussion on Reddit or Hacker News
  7. Answer Bridge related questions on StackOverflow
  8. Give a local usergroup presentation on Bridge
  9. Give a conference talk on Bridge
  10. Provide feedback (forums, GitHub or email)

Testing

Bridge is continually tested with the full test runner available at http://testing.bridge.net/.

Credits

Bridge is developed by the team at Object.NET. Frameworks and Tools for .NET Developers.

License

Apache License, Version 2.0

Please see LICENSE for details.