fabiocav / azure-mobile-apps-node

Azure Mobile Apps - Node SDK

This package is still in development! This software is still likely to change dramatically and have minimal documentation prior to official release. Use caution before using this in a production application.

Basic Usage

The Azure Mobile Apps Node.js SDK is an express middleware package which makes it easy to create a backend for your mobile application and get it running on Azure.

var app = require('express')(); // Create an instance of an Express app
var mobileApp = require('azure-mobile-apps')(); // Create an instance of a Mobile App with default settings

mobileApp.tables.add('TodoItem'); // Create a table for 'TodoItem' with default settings

app.use(mobileApp);
app.listen(process.env.PORT || 3000);

Installation

npm install --save azure-mobile-apps

Documentation & Resources

• API Documentation
• Tutorials & How-Tos
• StackOverflow #azure-mobile-services
• MSDN Forums
• Client & Server Quickstarts
• Samples
• Chat on Gitter

Quickstart

0. Create a new directory, initialize git, and initialize npm

mkdir quickstart

git init

npm init

0. Install (with npm) the azure-mobile-apps and express packages

npm install express azure-mobile-apps --save

0. Create a suitable .gitignore file. You can generate a suitable .gitignore file using the generator at gitignore.io

1. Create a server.js file and add the following code to the file:

var app = require('express')(); // Create an instance of an Express app
var mobileApp = require('azure-mobile-apps')(); // Create an instance of a Mobile App with default settings

mobileApp.tables.add('TodoItem'); // Create a table for 'TodoItem' with default settings

app.use(mobileApp);
app.listen(process.env.PORT || 3000);

0. Run your project locally with node server.js

1. Publish your project to an existing Azure Mobile App by adding it as a remote and pushing your changes.

git remote add azure https://{user}@{sitename}.scm.azurewebsites.net:443/{sitename}.git

git add package.json server.js

git commit -m 'Quickstart created'

git push azure master

For steps 4-5, you can use any of the clients found in the Client & Server Quickstarts to test.

GitHub Organization

Our GitHub repository has one branch with code in it - master. Each version is tagged with the version when we release a new version. We have three suffixes for the release. An alpha release indicates that the API may be unstable between releases and the library may not pass the end to end tests yet. You should not use an alpha release in production or testing. We release alpha releases to provide an early look at the library. Has all the functionality we expect in the final release and should be API stable, so it can be used for development. A beta library release may not pass end to end tests yet. A GA release passes all end to end tests and is recommended for production code.

We use GitHub Issues to track all work with this library. We use Milestones to track the work going into a particular release.

Contributing

For information on how to contribute to this project, please see the contributor guide.

Contact Us

We can be contacted via a variety of methods. The most effective are on Twitter (via @AzureMobile) and the MSDN Forums If you need to reference a GitHub Issue, ensure you cut-and-paste the URL of the issue into the message. You can also reach us on Gitter.

License

MIT