eoscostarica / eos-dapp-boilerplate

EOSIO Application Boilerplates 🚀
https://eoscostarica.io
MIT License
25 stars 9 forks source link

Poor Getting Started Documentation #13

Closed ryanleecode closed 5 years ago

ryanleecode commented 5 years ago

Summary

Getting started documentation is poor. It is not immediately obvious you need to run cd services/frontend && yarn && cd ../../ && make start instead of make start.

Steps to reproduce: How did you encounter the bug? Instructions to reproduce it.

Clone the project. Run make start.

Expected behavior: How did you expect it to behave?

It would fire up the app without problems

Actual behavior: How did it actually behave?

Complained that rimraf could not be found, which is obviously due to the node_modules folder being missing.

Possible Solutions

Changing the make start command to this cd services/frontend && yarn && cd ../../ && ./scripts/start.sh would be more appropiate.

gaboesquivel commented 5 years ago

rimraf is specified in the deps https://github.com/eoscostarica/eos-dapp-boilerplate/blob/master/services/frontend/package.json#L61

I just added yarn install to the start script https://github.com/eoscostarica/eos-dapp-boilerplate/commit/03d373b642dce4f5c8baa455e82e778880af1a5a

Let me know if that helps. Also please feel free to send pull requests for documentation improvements or any type of enhancements. We also have chat channel on discord https://eoscostarica.io/discord