Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

AlgoKit Quick Start Guide - add instructions for Typescript Users #1242

Open
noodles opened this issue Mar 6, 2024 · 0 comments
Open

AlgoKit Quick Start Guide - add instructions for Typescript Users #1242

noodles opened this issue Mar 6, 2024 · 0 comments

Comments

@noodles
Copy link

noodles commented Mar 6, 2024

Is your addition related to a problem? Please describe.

When following the instructions in the AlgoKit Quick Start Guide selecting "Typescript" instead of "Python" as the language to use for the smart contract is very different. Selecting Python creates the hello_world starter file (as described in the guide), it also gives you the option to select the programming language for the contract development code.

Selecting TypeScript does not ask for the name of the default smart contract app or the template preset. These differences should at least be explained in the guide because a TS developer is likely to select TS as the language for their smart contract and then be left wondering why everything is so different.

Python

% algokit init
? Which of these options best describes the project you want to build? Smart Con
tracts 📜
? Which language would you like to use for the smart contract? Python 🐍
? Name of project / directory to create the project in:  py_proj
Starting template copy and render at /Users/nds/Documents/algo/py_proj/projects/py_proj...
🎤 Name of the default smart contract app.
   hello_world
🎤 Name of the template preset to use.
   Starter - for a simpler starting point ideal for prototyping
🎤 What programming language do you want to use for your contract deployment code?
   Python
Template render complete! 

TypeScript

% algokit init
? Which of these options best describes the project you want to build? Smart Contracts 📜
? Which language would you like to use for the smart contract? TypeScript 📘
? Name of project / directory to create the project in:  ts_project
Starting template copy and render at /Users/nds/Documents/algo/ts_project/projects/ts_project...
Template render complete!

Describe the solution you'd like

Updated documentation that clearly explains the different options in the (new) CLI and the outcomes of selecting them. If the experience is not consistent across programming languages then it should be documented.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant