https://github.com/mariusconjeaud/nodejs-az-functions-api

Template for Azure Functions API with Node.js runtime
https://github.com/mariusconjeaud/nodejs-az-functions-api

azure-devops azure-functions nodejs nodejs-api openapi3

Last synced: 18 days ago
JSON representation

Template for Azure Functions API with Node.js runtime

• Host: GitHub
• URL: https://github.com/mariusconjeaud/nodejs-az-functions-api
• Owner: mariusconjeaud
• Created: 2020-03-27T10:51:27.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2023-01-05T17:23:41.000Z (almost 2 years ago)
• Last Synced: 2024-10-15T06:09:28.352Z (about 1 month ago)
• Topics: azure-devops, azure-functions, nodejs, nodejs-api, openapi3
• Language: HTML
• Size: 791 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 11
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Requirements

You need to have installed :

* Node.js version 12 LTS from [here](https://nodejs.org/en/download/).

* Azure Functions Core Tools. To install it, execute the following command :

```bash

npm install -g azure-functions-core-tools

```

# Start Azure Functions

Azure Functions Core Tools enables you to execute your Functions runtime locally. To do so, execute the following command :

```bash

func start

```

If everything is working properly, you should get the following CLI output :

![CLI output](docs/func_start_output.png "Successful CLI Output")

To verify that the API is working properly, go to the following URL : .

## Note on potential errors

Depending on the configuration of your machine, you might need to install the [.NET Core 2.x SDK](https://dotnet.microsoft.com/download).

This is because Functions are built on top on .NET Core. When you start the Functions runtime, it spins up a .NET Core runtime, in which the desired runtime of your functions - Node.js in our case - runs.

You normally don't need this with this project, as we make use of the extensions bundle. But just in case, here's a warning...