search

vechain / x-app-template

Vechain VeBetterDAO X-App template
363 stars 313 forks source link

Add quick start example #25

Closed ifavo closed 6 days ago

ifavo commented 1 week ago

This PR aims to simplify the start for impatient developers on the app template:

ifavo commented 6 days ago

Possible solution could be adding the "Result" section of the Quickstart below the Readme here:

👋 not sure what you mean by that. Would this be adding the link table to the first section?

I agree with the potential copy & paste misunderstanding. It is stated at the top as required variable.

I went back with my original frustration about the required amount of ENV and found that envalid is used to verify PORT and NODE_ENV only. I've modified it slightly to verify all the ENV and also use the verified ENV. In the process adjusted, it now also sets some default values and has an OpenAPI-Key verifier, that informs the user where to obtain one.

What do you think about the change?

pierobassa commented 6 days ago

Possible solution could be adding the "Result" section of the Quickstart below the Readme here:

👋 not sure what you mean by that. Would this be adding the link table to the first section?

I agree with the potential copy & paste misunderstanding. It is stated at the top as required variable.

I went back with my original frustration about the required amount of ENV and found that envalid is used to verify PORT and NODE_ENV only. I've modified it slightly to verify all the ENV and also use the verified ENV. In the process adjusted, it now also sets some default values and has an OpenAPI-Key verifier, that informs the user where to obtain one.

What do you think about the change?

Nice catch! Could you have a reference to the Quickstart.mdin the Readme.md too?

ifavo commented 6 days ago

I did add a link to the README, hope its what you expect. Feel free to adjust the way you like to see it!