Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nestjs/azure-func-http
Azure Functions HTTP adapter for Nest framework (node.js) π₯
https://github.com/nestjs/azure-func-http
azure javascript nest nestjs node-framework nodejs serverless typescript
Last synced: about 1 month ago
JSON representation
Azure Functions HTTP adapter for Nest framework (node.js) π₯
- Host: GitHub
- URL: https://github.com/nestjs/azure-func-http
- Owner: nestjs
- License: mit
- Created: 2019-07-25T10:45:38.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-04-14T09:07:32.000Z (7 months ago)
- Last Synced: 2024-04-14T09:34:46.389Z (7 months ago)
- Topics: azure, javascript, nest, nestjs, node-framework, nodejs, serverless, typescript
- Language: TypeScript
- Homepage: https://nestjs.com/
- Size: 5.99 MB
- Stars: 146
- Watchers: 6
- Forks: 36
- Open Issues: 20
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
[travis-image]: https://api.travis-ci.org/nestjs/nest.svg?branch=master
[travis-url]: https://travis-ci.org/nestjs/nest
[linux-image]: https://img.shields.io/travis/nestjs/nest/master.svg?label=linux
[linux-url]: https://travis-ci.org/nestjs/nest
A progressive Node.js framework for building efficient and scalable server-side applications.
## Description
[Azure Functions](https://code.visualstudio.com/tutorials/functions-extension/getting-started) HTTP module for [Nest](https://github.com/nestjs/nest).
## Installation
Using the Nest CLI:
```bash
$ nest add @nestjs/azure-func-http
```
Example output:
```bash
β Installation in progress... β
CREATE /.funcignore (66 bytes)
CREATE /host.json (23 bytes)
CREATE /local.settings.json (116 bytes)
CREATE /proxies.json (72 bytes)
CREATE /main/function.json (294 bytes)
CREATE /main/index.ts (287 bytes)
CREATE /main/sample.dat (23 bytes)
CREATE /src/main.azure.ts (321 bytes)
UPDATE /package.json (1827 bytes)
```
## Tutorial
You can read more about this integration [here](https://trilon.io/blog/deploy-nestjs-azure-functions).
## Native routing
If you don't need the compatibility with `express` library, you can use a native routing instead:
```typescript
const app = await NestFactory.create(AppModule, new AzureHttpRouter());
```
`AzureHttpRouter` is exported from `@nestjs/azure-func-http`. Since `AzureHttpRouter` doesn't use `express` underneath, the routing itself is much faster.
## Additional options
You can pass additional flags to customize the post-install schematic. For example, if your base application directory is different than `src`, use `--rootDir` flag:
```bash
$ nest add @nestjs/azure-func-http --rootDir app
```
Other available flags:
- `rootModuleFileName` - the name of the root module file, default: `app.module`
- `rootModuleClassName` - the name of the root module class, default: `AppModule`
- `skipInstall` - skip installing dependencies, default: `false`
## Support
Nest is an MIT-licensed open source project. It can grow thanks to the sponsors and support by the amazing backers. If you'd like to join them, please [read more here](https://docs.nestjs.com/support).
## Stay in touch
- Author - [Kamil MyΕliwiec](https://twitter.com/kammysliwiec)
- Website - [https://nestjs.com](https://nestjs.com/)
- Twitter - [@nestframework](https://twitter.com/nestframework)
## License
Nest is [MIT licensed](LICENSE).