Skip to content

Commit 371ccfa

Browse files
committed
docs: README update
1 parent 141fe46 commit 371ccfa

File tree

1 file changed

+21
-16
lines changed

1 file changed

+21
-16
lines changed

README.md

Lines changed: 21 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,40 +1,45 @@
11
<div align="center">
2-
<a href="https://github.com/algorandfoundation/algokit-python-template"><img src="https://bafkreihnmpvtrgloxz5exuk2ybfxkeq5b2ka5vxfjejjslswl5ecr7pvpy.ipfs.nftstorage.link/" width=60%></a>
2+
<a href="https://github.com/algorandfoundation/algokit-typescript-template"><img src="https://bafkreihnmpvtrgloxz5exuk2ybfxkeq5b2ka5vxfjejjslswl5ecr7pvpy.ipfs.nftstorage.link/" width=60%></a>
33
</div>
44

55
<p align="center">
66
<a target="_blank" href="https://github.com/algorandfoundation/algokit-cli"><img src="https://img.shields.io/badge/docs-repository-00dc94?logo=github&style=flat.svg" /></a>
77
<a target="_blank" href="https://developer.algorand.org/algokit/"><img src="https://img.shields.io/badge/learn-AlgoKit-00dc94?logo=algorand&mac=flat.svg" /></a>
8-
<a target="_blank" href="https://github.com/algorandfoundation/algokit-python-template"><img src="https://img.shields.io/github/stars/algorandfoundation/algokit-python-template?color=00dc94&logo=star&style=flat" /></a>
9-
<a target="_blank" href="https://developer.algorand.org/algokit/"><img src="https://api.visitorbadge.io/api/visitors?path=https%3A%2F%2Fgithub.com%2Falgorandfoundation%2Falgokit-python-template&countColor=%2300dc94&style=flat" /></a>
8+
<a target="_blank" href="https://github.com/algorandfoundation/algokit-python-template"><img src="https://img.shields.io/github/stars/algorandfoundation/algokit-typescript-template?color=00dc94&logo=star&style=flat" /></a>
9+
<a target="_blank" href="https://developer.algorand.org/algokit/"><img src="https://api.visitorbadge.io/api/visitors?path=https%3A%2F%2Fgithub.com%2Falgorandfoundation%2Falgokit-typescript-template&countColor=%2300dc94&style=flat" /></a>
1010
</p>
1111

1212
---
1313

14-
This template provides a production-ready baseline for developing and deploying [Puya](https://github.com/algorandfoundation/puya) smart contracts.
14+
This template provides a production-ready baseline for developing and deploying [Algorand TypeScript](https://github.com/algorandfoundation/puya-ts) smart contracts.
1515

16-
To use it [install AlgoKit](https://github.com/algorandfoundation/algokit-cli#readme) and then either pass in `-t python` to `algokit init` or select the `python` template.
16+
~~To 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.~~
17+
18+
To use it run:
19+
```
20+
algokit init --template-url https://github.com/algorandfoundation/algokit-typescript-template --UNSAFE-SECURITY-accept-template-url
21+
```
1722

1823
This 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/).
1924

2025
## Features
2126

2227
This template supports the following features:
2328

24-
- Compilation of [multiple Puya contracts](template_content/smart_contracts/config.py) to a [predictable folder location and file layout](template_content/smart_contracts/__main__.py) where they can be deployed
29+
- 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)
2530
- Deploy-time immutability and permanence control
26-
- [Poetry](https://python-poetry.org/) for Python dependency management and virtual environment management
27-
- Linting via [Ruff](https://github.com/charliermarsh/ruff) or [Flake8](https://flake8.pycqa.org/en/latest/)
28-
- Formatting via [Black](https://github.com/psf/black)
29-
- Type checking via [mypy](https://mypy-lang.org/)
30-
- Testing via pytest (not yet used)
31-
- Dependency vulnerability scanning via pip-audit (not yet used)
31+
- [NPM](https://www.npmjs.com/) for TypeScript packaging and dependency management
32+
- [TypeScript](https://www.typescriptlang.org/) for strongly typed programming language that builds on JavaScript
33+
- [ts-node-dev](https://github.com/wclr/ts-node-dev) for TypeScript deployment script execution
34+
- [Prettier](https://prettier.io/) for code formatting
35+
- [ESLint](https://eslint.org/) for linting
36+
- [vitest](https://vitest.dev/) for automated testing (unit test and end-to-end)
37+
- [better-npm-audit](https://github.com/jeemok/better-npm-audit#readme) for dependency vulnerability scanning
38+
- [pre-commit](https://pre-commit.com/) for managing and maintaining multi-language pre-commit hooks
3239
- VS Code configuration (linting, formatting, breakpoint debugging)
33-
- dotenv (.env) file for configuration
34-
- Automated testing of the compiled smart contracts
40+
- dotenv (.env) files for configuration
3541
- [Output stability](https://github.com/algorandfoundation/algokit-cli/blob/main/docs/articles/output_stability.md) tests of the TEAL output
36-
- CI/CD pipeline using GitHub Actions:
37-
- - Optionally pick deployments to Netlify or Vercel
42+
- CI/CD pipeline using GitHub Actions
3843

3944
## Getting started
4045

0 commit comments

Comments
 (0)