{"id":31902940,"url":"https://github.com/algorandfoundation/algokit-TypeScript-template","last_synced_at":"2025-10-13T13:05:35.405Z","repository":{"id":272328131,"uuid":"914306452","full_name":"algorandfoundation/algokit-typescript-template","owner":"algorandfoundation","description":"Official AlgoKit template for smart contract development project using Algorand TypeScript.","archived":false,"fork":false,"pushed_at":"2025-09-23T01:51:09.000Z","size":211,"stargazers_count":4,"open_issues_count":5,"forks_count":5,"subscribers_count":4,"default_branch":"main","last_synced_at":"2025-09-23T03:38:16.561Z","etag":null,"topics":["algokit","algokit-template","algorand","algorand-blockchain","algorand-smart-contract","typescript"],"latest_commit_sha":null,"homepage":"","language":"Jinja","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/algorandfoundation.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":null,"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,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-01-09T10:42:35.000Z","updated_at":"2025-08-12T06:31:15.000Z","dependencies_parsed_at":"2025-02-21T09:23:31.807Z","dependency_job_id":"8a066dbd-3931-40ba-b27e-43eb683b9631","html_url":"https://github.com/algorandfoundation/algokit-typescript-template","commit_stats":null,"previous_names":["algorandfoundation/algokit-typescript-template"],"tags_count":17,"template":false,"template_full_name":null,"purl":"pkg:github/algorandfoundation/algokit-typescript-template","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/algorandfoundation%2Falgokit-typescript-template","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/algorandfoundation%2Falgokit-typescript-template/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/algorandfoundation%2Falgokit-typescript-template/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/algorandfoundation%2Falgokit-typescript-template/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/algorandfoundation","download_url":"https://codeload.github.com/algorandfoundation/algokit-typescript-template/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/algorandfoundation%2Falgokit-typescript-template/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":279015270,"owners_count":26085683,"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","status":"online","status_checked_at":"2025-10-13T02:00:06.723Z","response_time":61,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["algokit","algokit-template","algorand","algorand-blockchain","algorand-smart-contract","typescript"],"created_at":"2025-10-13T13:01:30.792Z","updated_at":"2025-10-13T13:05:35.388Z","avatar_url":"https://github.com/algorandfoundation.png","language":"Jinja","funding_links":[],"categories":["Core Resources"],"sub_categories":["AlgoKit Templates"],"readme":"\u003cdiv align=\"center\"\u003e\n\u003ca href=\"https://github.com/algorandfoundation/algokit-typescript-template\"\u003e\u003cimg src=\"https://bafybeid5333wj4vvxc3yyif3dzrewowos46sq2vj55r7u3vyhazhoyffo4.ipfs.nftstorage.link/\" width=60%\u003e\u003c/a\u003e\n\u003c/div\u003e\n\n\u003cp align=\"center\"\u003e\n    \u003ca target=\"_blank\" href=\"https://github.com/algorandfoundation/algokit-cli\"\u003e\u003cimg src=\"https://img.shields.io/badge/docs-repository-00dc94?logo=github\u0026style=flat.svg\" /\u003e\u003c/a\u003e\n    \u003ca target=\"_blank\" href=\"https://algorand.co/algokit/\"\u003e\u003cimg src=\"https://img.shields.io/badge/learn-AlgoKit-00dc94?logo=algorand\u0026mac=flat.svg\" /\u003e\u003c/a\u003e\n    \u003ca target=\"_blank\" href=\"https://github.com/algorandfoundation/algokit-typescript-template\"\u003e\u003cimg src=\"https://img.shields.io/github/stars/algorandfoundation/algokit-typescript-template?color=00dc94\u0026logo=star\u0026style=flat\" /\u003e\u003c/a\u003e\n    \u003ca target=\"_blank\" href=\"https://algorand.co/algokit/\"\u003e\u003cimg  src=\"https://api.visitorbadge.io/api/visitors?path=https%3A%2F%2Fgithub.com%2Falgorandfoundation%2Falgokit-typescript-template\u0026countColor=%2300dc94\u0026style=flat\" /\u003e\u003c/a\u003e\n\u003c/p\u003e\n\n---\n\nThis template provides a beta template for developing and deploying [Algorand TypeScript](https://github.com/algorandfoundation/puya-ts) smart contracts.\n\nTo use it [install AlgoKit](https://github.com/algorandfoundation/algokit-cli#readme) and then either pass in `-t typescript` to `algokit init` or select the `typescript` template.\n\nThis is one of the official templates used by AlgoKit to initialize an Algorand smart contract project. It's a [Copier template](https://copier.readthedocs.io/en/stable/).\n\n## Features\n\nThis template supports the following features:\n\n- Compilation of multiple [Algorand TypeScript](https://github.com/algorandfoundation/puya-ts/) contracts to a [predictable folder location and file layout](template_content/smart_contracts) where they can be deployed; [docs](https://github.com/algorandfoundation/puya-ts/), [examples](https://github.com/algorandfoundation/puya-ts/tree/main/examples)\n- Deploy-time immutability and permanence control\n- [NPM](https://www.npmjs.com/) for TypeScript packaging and dependency management\n- [TypeScript](https://www.typescriptlang.org/) for strongly typed programming language that builds on JavaScript\n- [ts-node-dev](https://github.com/wclr/ts-node-dev) for TypeScript deployment script execution\n- [Prettier](https://prettier.io/) for code formatting\n- [ESLint](https://eslint.org/) for linting\n- [vitest](https://vitest.dev/) for automated testing (unit test and end-to-end)\n- [better-npm-audit](https://github.com/jeemok/better-npm-audit#readme) for dependency vulnerability scanning\n- [pre-commit](https://pre-commit.com/) for managing and maintaining multi-language pre-commit hooks\n- VS Code configuration (linting, formatting, breakpoint debugging)\n- dotenv (.env) files for configuration\n- [Output stability](https://github.com/algorandfoundation/algokit-cli/blob/main/docs/articles/output_stability.md) tests of the TEAL output\n- CI/CD pipeline using GitHub Actions\n\n## Getting started\n\nOnce the template is instantiated you can follow the [README.md](template_content/README.md.jinja) file to see instructions for how to use the template.\n\n### Interactive Wizard\n\n**To initialize using the `algokit` CLI**:\n\n- Execute the command `algokit init`. This initiates an interactive wizard that assists in selecting the most appropriate template for your project requirements.\n\n**To initialize within GitHub Codespaces**:\n\n- Follow these steps to leverage GitHub Codespaces for template selection:\n\n  1. Go to the [algokit-base-template](https://github.com/algorandfoundation/algokit-base-template) repository.\n  2. Initiate a new codespace by selecting the `Create codespace on main` option. This can be found by clicking the `Code` button, then navigating to the `Codespaces` tab.\n  3. Upon codespace preparation, `algokit` will automatically start `LocalNet` and present a prompt with the next steps. Executing `algokit init` will initiate the interactive wizard.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falgorandfoundation%2Falgokit-TypeScript-template","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Falgorandfoundation%2Falgokit-TypeScript-template","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falgorandfoundation%2Falgokit-TypeScript-template/lists"}