{"id":23329055,"url":"https://github.com/code-and-sorts/cookie-ts-az-func-api","last_synced_at":"2025-04-07T08:59:05.820Z","repository":{"id":264255028,"uuid":"892775046","full_name":"Code-and-Sorts/cookie-ts-az-func-api","owner":"Code-and-Sorts","description":"Example Typescript NodeJS Azure Function App project using the Cookiecutter API template.","archived":false,"fork":false,"pushed_at":"2024-11-22T22:29:35.000Z","size":69,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-02-13T12:42:55.292Z","etag":null,"topics":["azure-functions","cookiecutter","example","nodejs","typescript"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Code-and-Sorts.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-11-22T18:51:57.000Z","updated_at":"2024-11-30T09:33:06.000Z","dependencies_parsed_at":"2024-11-22T23:33:42.271Z","dependency_job_id":null,"html_url":"https://github.com/Code-and-Sorts/cookie-ts-az-func-api","commit_stats":null,"previous_names":["code-and-sorts/cookie-ts-az-func-api"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Code-and-Sorts%2Fcookie-ts-az-func-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Code-and-Sorts%2Fcookie-ts-az-func-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Code-and-Sorts%2Fcookie-ts-az-func-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Code-and-Sorts%2Fcookie-ts-az-func-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Code-and-Sorts","download_url":"https://codeload.github.com/Code-and-Sorts/cookie-ts-az-func-api/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247623009,"owners_count":20968574,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["azure-functions","cookiecutter","example","nodejs","typescript"],"created_at":"2024-12-20T21:31:28.621Z","updated_at":"2025-04-07T08:59:05.802Z","avatar_url":"https://github.com/Code-and-Sorts.png","language":"TypeScript","readme":"# Kitten-Claws API\n\n## Overview\n\nThis project is a Typescript NodeJS-based REST API built using [Azure Function Apps](https://learn.microsoft.com/en-us/azure/azure-functions/). The API leverages Azure's serverless architecture, allowing you to deploy and scale functions effortlessly in the cloud. The HTTP-triggered functions serve as the endpoints for the API, providing a seamless way to handle client requests.\n\nThe REST API has the following endpoints:\n- GET (by ID)\n- GET (list)\n- POST\n- PATCH\n- DELETE (soft-delete)\n\nDependency management is handled using [Yarn](https://yarnpkg.com/), ensuring a streamlined and consistent environment for managing node packages and their dependencies.\n\n## Features\n\n- Azure Function Apps: Utilizes Azure's serverless platform to create scalable and efficient endpoints with HTTP triggers.\n\n- Typescript NodeJS-Based: Written entirely in Typescript NodeJS, leveraging its rich ecosystem and libraries for rapid development.\n\n- Yarn for Dependency Management: Manages all node dependencies with Yarn, making the development environment consistent and easy to set up.\n\n- Cosmos DB NoSQL Account: This project uses Cosmos DB NoSQL database.\n\n## Prerequisites\n\n- NodeJS \u003e=18.x, \u003c=20.x\n\n- [Azure Functions Core Tools](https://github.com/Azure/azure-functions-core-tools): To run the Function Apps locally.\n\n- [Azure CLI](https://learn.microsoft.com/en-us/cli/azure/): To deploy and manage Azure Function Apps.\n\n- [Yarn](https://yarnpkg.com/): For dependency management.\n\n- Azure Account: An active Azure subscription for deploying the Function App.\n\n- Cosmos DB NoSQL Account either deployed in Azure or [emulated](https://learn.microsoft.com/en-us/azure/cosmos-db/how-to-develop-emulator?tabs=docker-linux%2Ccsharp\u0026pivots=api-nosql).\n\n## Setup and Installation\n\n1. Install Azure Functions Core Tools\n\n    Follow the [documentation](https://learn.microsoft.com/en-us/azure/azure-functions/functions-run-local?tabs=linux%2Cisolated-process%2Cnode-v4%2Cpython-v2%2Chttp-trigger%2Ccontainer-apps\u0026pivots=programming-language-typescript#install-the-azure-functions-core-tools) to install Azure Function Core Tools based on your operating system.\n\n2. Install Yarn\n\n    If you haven't already installed Yarn, you can do so by following the [official installation guide](https://yarnpkg.com/getting-started/install).\n\n3. Install Dependencies\n\n    Install all dependencies:\n\n    ```console\n    yarn\n    ```\n\n    To be able to run the project locally, set the environment variable values in the .env project file.\n\n4. Run the API Locally\n\n    ```console\n    yarn build\n    yarn start\n    ```\n\n    This command starts the local development server using the Azure Function Core Tools, where you can interact with your API endpoints.\n\n5. Thunderclient\n\n    Included in the project is a [Thunderclient](https://www.thunderclient.com/) collection in the .thunderclient directory to easily test the locally hosted APIs.\n\n## Development Workflow\n\n### Adding a New Dependency\n\n```bash\nyarn add \u003cpackage-name\u003e\n```\n\n### Removing a Dependency\n\n```bash\nyarn remove \u003cpackage-name\u003e\n```\n\n## Running Tests\n\nEnsure your code is working as expected by running unit tests using pytest:\n\n```bash\nyarn test:unit\n```\n\n## Repository structure\n\n```text\n└── cookiecutter-template-typescript\n    ├── .thunderclient     - Thunderclient collection\n    ├── config             - Depency injection config\n    ├── controller         - Controllers\n    ├── functions          - Function App methods\n    ├── repository         - Cosmos DB repository\n    ├── service            - Services\n    ├── types              - Zod models and errors\n    └── utils              - Error detect \u0026 response generator utilities\n```\n\n## License\n\nThis project is licensed under the MIT License. See the LICENSE file for details.\n\n---\n\nRepository generated with [Code-and-Sorts/cookiecutter-api](https://github.com/Code-and-Sorts/cookiecutter-api).\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcode-and-sorts%2Fcookie-ts-az-func-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcode-and-sorts%2Fcookie-ts-az-func-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcode-and-sorts%2Fcookie-ts-az-func-api/lists"}