RE: Seed - Development - Modules, Smart Contracts & The SVM
I didn't dig too deep in the project but purely from a developer point of view the quality of your code is really great especially regarding the comments. They have a real value and help understand your code and how to use it.
However a few things are kind of weird.
Why did you commit your node_modules folder ? You shouldn't do that.
The files .DS_Store should also be excluded. If I'm not mistaken they only exist for Apple devices right ?
Add a .gitignore file to help you with all that.
Your package.json files are weird too.
This one for instance https://github.com/CarsonRoscoe/Seed/blob/develop/seedSrc/package.json
the dependencies don't match the content of the node_modules folder. The entry point seed.js
doesn't exist either. The scripts only has a test
command.
Good luck for your project!
Your contribution has been evaluated according to Utopian policies and guidelines, as well as a predefined set of questions pertaining to the category.
To view those questions and the relevant answers related to your post, click here.
Need help? Write a ticket on https://support.utopian.io/.
Chat with us on Discord.
[utopian-moderator]
Hey @gregory.latinier
Here's a tip for your valuable feedback! @Utopian-io loves and incentivises informative comments.
Contributing on Utopian
Learn how to contribute on our website.
Want to chat? Join us on Discord https://discord.gg/h52nFrV.
Vote for Utopian Witness!
Thank you for the kind words!
This is my first project being created using NodeJS, and I realize now I messed up with setting up the modules and such. I'll fix up the gitignore for the .DS_Store and node_modules folder, since users should be able to simply install all the modules themselves upon cloning.
As for the package.json file, that was a mistake upon the initial project creation. The client is launched from the /clientSrc directory using "npm start", however I see now that I most likely did an improper npm init in different places when first building the project, which is the package.json file you're referring to.
Really, there should be two npm packages, one for /clientSrc for the Electron client, and one for /seedSrc to become a publicly available npm package.
I'll make sure to have that all cleaned up for the next contribution, as well as add a "How To Run" into the README to clarify users should launch from the /clientSrc folder in order to launch the client.
Thank you again for the kind words and the helpful advice! Have a wonderful day,
~ Carson Roscoe