rakesh-mohanta / nodejs-guidelines

Tips, tricks, and resources for working with Node.js, and the start of an ongoing conversation on how we can improve the Node.js experience on Microsoft platforms.

Microsoft + Node.js Guidelines

Microsoft ❤️ Node.js!

We work hard to contribute to the Node.js community and we want to make sure your experience is as seamless as possible. In particular, our goals here are to:

• make it easier for people using Microsoft services and technologies to get started on the right foot with Node.js
• consolidate Microsoft's Node.js offerings in a centralized place to make it easier for you to find information
• communicate status on key issues we're addressing and collect feedback from the Node.js community on how we can do better.
• provide a forum to connect with various teams at Microsoft working on improving the Node.js experience.

Note that this is not intended to be a comprehensive set of recommendations. Rather it's meant to be a helpful set of content that makes it easier to avoid any potential gotchas, and the beginning of what we expect to be an ongoing conversation on how we can improve the Node.js experience on Microsoft platforms.

Emoji legend

💡 This is a tip that provides the reader with some additional info that's not necessary, but potentially useful for the task at hand.

🚩 TODO This describes a todo item that we'd like some help with.

📈 IN PROGRESS This provides awareness about an important issue that we're currently working on resolving.

Node.js tips, tricks, resources, and more!

• Hello World
• Working with npm packages
  • Using an existing npm package
  • Managing npm dependencies
  • Publishing npm packages to the registry
  • Local vs. Global packages
• Using nodemon
• Configuring your Windows development environment
  • Command-line console recommendations and other tools
  • Editors and IDEs
  • MAX_PATH explanation and workarounds
  • Compiling native Addon modules
• Building for cross-platform
• Deployment
• Application-specific tips
• Node.js + Microsoft products, services, and contributions
• Anything you want!

Node.js + Microsoft products, services, and contributions

• Visual Studio Code: Lightweight cross-platform editor for building and debugging modern web and cloud applications.
• Node.js Tools for Visual Studio: Free, open-source extension that turns Visual Studio into a powerful Node.js development environment.
• TypeScript: TypeScript is a language for application scale JavaScript development.
  • Also useful for working with typescript is tsd, which enables you to quickly download TypeScript definition files.
• Azure SDK for Node.js: We provide both fine-grained modules for different Microsoft Azure services which you can install separately, and an all-up module which contains everything.
• Application Insights: Monitor your application's performance and usage with just a few lines of code.
• Node-Chakra and Windows IoT: This project enables Node.js to optionally use the Chakra JavaScript engine on Windows 10, allowing Node.js to run on Windows 10 IoT.
• Visual Studio Online
• Docker Tools, yo docker
• Node.js Technical Steering Committee and Node.js Foundation Board
• Others

🚩 TODO Add other Microsoft services related to Node.js.

Contributions Welcome!

This is still a work in progress, an experiment - if you will, and we'd love your help to make it better! Please see our contributing guidelines for details.