https://github.com/thaitype/nammatham
Azure Functions Framework
https://github.com/thaitype/nammatham
azure azure-functions faas functions hacktoberfest nammatham nodejs serverless typescript
Last synced: 2 days ago
JSON representation
Azure Functions Framework
- Host: GitHub
- URL: https://github.com/thaitype/nammatham
- Owner: thaitype
- License: mit
- Created: 2023-01-01T16:16:58.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-12-24T11:41:45.000Z (over 1 year ago)
- Last Synced: 2026-04-04T12:57:20.915Z (2 days ago)
- Topics: azure, azure-functions, faas, functions, hacktoberfest, nammatham, nodejs, serverless, typescript
- Language: TypeScript
- Homepage: https://nammatham.thaitype.dev/
- Size: 2.5 MB
- Stars: 71
- Watchers: 1
- Forks: 3
- Open Issues: 57
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Type-safe Serverless Library for Azure Functions and friends
> 🚧 Alpha Stage: Internal Use Only 🚧
>
> Please note that Nammatham v2 is currently in its Alpha stage and is intended for internal use only. As we actively develop and refine the platform, be aware that the API may undergo frequent changes. [Tracking v2 Roadmap](https://github.com/thaitype/nammatham/issues?q=is%3Aissue+is%3Aopen+label%3Av2-blocker)
>
> Note: [Nammatham v1](https://www.npmjs.com/package/nammatham) is currently in maintenance mode. no new features are actively being developed
You're reading v2 docs
| Version | Status | Azure Functions
Node.js Lib | Branch | Build Status |
| ------- | ----------- | ----------------------- | ------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| v1.x | Maintenance | v3.x | [v1.x][v1.x] | [](https://github.com/thaitype/nammatham/actions/workflows/test.yml) [](https://codecov.io/gh/thaitype/nammatham) |
| v2.x | Alpha | v4.x | [main][main] | [](https://github.com/thaitype/nammatham/actions/workflows/test.yml) [](https://codecov.io/gh/thaitype/nammatham) |
[v1.x]: https://github.com/thaitype/nammatham/tree/v1.x
[main]: https://github.com/thaitype/nammatham/tree/main
## Description
Nammatham (นามธรรม in Thai, pronounced `/naam ma tham/`, means **abstract** in Thai) is Azure Function Nodejs.
## Getting Started for Azure Functions
### Install
```bash
# Including all packages
npm install nammatham@alpha
```
### Example
You can see [examples](examples) or follow the minimal app getting started below:
> `initNammatham.create()` is a factory function for creating Nammatham App, it's a wrapper for Azure Functions App.
```typescript
import { initNammatham, expressPlugin } from 'nammatham';
const n = initNammatham.create();
const func = n.func;
const app = n.app;
const helloFunction = func
.httpGet('hello', {
route: 'hello-world',
})
.handler(async c => {
c.context.log('HTTP trigger function processed a request.');
c.context.debug(`Http function processed request for url "${c.trigger.url}"`);
const name = c.trigger.query.get('name') || (await c.trigger.text()) || 'world';
return c.text(`Hello, ${name}!`);
});
app.addFunctions(helloFunction);
const dev = process.env.NODE_ENV === 'development';
app.register(expressPlugin({ dev }));
app.start();
```
Then edit `package.json` like this;
```json
{
"main": "dist/src/main.js",
"scripts": {
"dev": "cross-env NODE_ENV=development tsx watch src/main.ts",
"start": "tsc && func start"
}
}
```
Run Dev Server on locally, (For dev server use `tsx watch` for reloading run dev server using `express` )
```
npm run dev
```
Run Azure Functions on locally (Using Official Azure Functions Node.js)
```
npm start
```
## Nammatham Packages
- [core][@nammatham/core], Nammatham Core package for initializing Nammatham App
### Available Adatpers
- [azure-functions][@nammatham/azure-functions], Azure Functions Adapter for Nammatham, internally, Azure Functions in local dev mode is dependend on Express.js.
### Available Plugins
- [express][@nammatham/express], Express Plugin for run server. Nammatham itself doesn't contain any server, enabling this plugin to provide better DX than the original server e.g. Azure Functions Runtime
- [trpc-azure-functions][@nammatham/trpc-azure-functions], provide [tRPC](https://trpc.io/) Plugin for Azure Functions, inclduing [express][@nammatham/express] server for local testing.
[@nammatham/core]: packages/core
[@nammatham/azure-functions]: packages/azure-functions
[@nammatham/express]: packages/express
[@nammatham/trpc-azure-functions]: packages/trpc-azure-functions
## Talks
Empowering TypeScript on Azure Functions with Nammatham, Azure Open Source Day @ Microsoft Thailand, 25 Mar 2023
[](https://www.youtube.com/watch?v=n6B4-5Lt2h0) (Thai speech, subtitle will added later)
- Slides: https://docs.google.com/presentation/d/1WUIXaUxXaiixZ2bgGCfx-f4Gdrmjl4RfbwKaEfAC6t4/edit?usp=sharing
## Local Dev Setup
```bash
# Install dependencies
pnpm install
# Before dev (Update workspace to local dependencies)
pnpm pre-local && pnpm install
# While dev
pnpm dev
# After dev before submitting PRs (Update workspace to actual dependencies), `pnpm install` for making sure lockfile is correct.
pnpm post-local && pnpm install
# Release package
pnpm release
```
## Inspiration
- [Azure Functions .NET](https://learn.microsoft.com/en-us/azure/azure-functions/create-first-function-cli-csharp?tabs=azure-cli%2Cin-process)
- [inversify-express-utils](https://github.com/inversify/inversify-express-utils) - We use inversify as a Dependency Injection Tool.
- [Nestjs](https://nestjs.com/)
- [typestack/routing-controllers](https://github.com/typestack/routing-controllers)
- [azure-middleware](https://github.com/emanuelcasco/azure-middleware) - Azure Functions Middleware Libray
## Author
- Thada Wangthammang, Software Engineer, Thailand