Improvement for templates in `create-aleo-app`

ProvableHQ / sdk

A Software Development Kit (SDK) for Zero-Knowledge Transactions

https://provable.tools

GNU General Public License v3.0

592 stars 471 forks source link

Improvement for templates in `create-aleo-app` #831

Closed WillXing closed 9 months ago

WillXing commented 10 months ago

Motivation

The templates in create-aleo-app is great start point for builders.

This PR is to improve the experience and usability by following changes:

Update program string from concat(+) to string template to improve the readability
Utilize localProgramExecution to use arguments as expected. This can be easier for user to understand the intention and how aleo program executed in app

Test Plan

Currently no unit test in templates, could be next things to working on. Now test plan is running them locally.

onetrickwolf commented 10 months ago

Thanks for catching these yeah this is much more readable and clearly we meant to do something with those arguments and forgot haha.

Will review these next week need to take some time and update some other areas of the SDK and test.

Currently no unit test in templates, could be next things to working on. Now test plan is running them locally.

We have some e2e's in the works for this if you have any suggestions or opinions let me know though! I think I want to avoiding including unit tests in the templates themselves just so they can be lighter weight for people trying to start fast. Probably will set it up as some top level folder in create-aleo-app

WillXing commented 10 months ago

I think I want to avoiding including unit tests in the templates themselves just so they can be lighter weight for people trying to start fast.

fair point, standalone e2e sounds like a good fit which can test multiple projects regardless the tech stack. 👍

WillXing commented 9 months ago

Hi @onetrickwolf , how's things going. Got any time to review/approve this?

onetrickwolf commented 9 months ago

Hey @WillXing yeah sorry we've been stress testing the network last two weeks: https://twitter.com/AleoHQ/status/1744816856978915557

Back to normal flow this Monday, hoping to churn through some reviews and general SDK improvements over the next two weeks, sorry for delay appreciate the contribution!