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

Inconsistencies between docs and js-abci #21

Closed
Ivshti opened this issue Jun 25, 2018 · 2 comments
Closed

Inconsistencies between docs and js-abci #21

Ivshti opened this issue Jun 25, 2018 · 2 comments

Comments

@Ivshti
Copy link

Ivshti commented Jun 25, 2018

I discovered a few inconsistencies between the docs ( https://tendermint.readthedocs.io/en/master/getting-started.html ) and the latest version of this repo

  1. The tutorial references example/app.js, when this repo has example/counter.js
  2. Tendermint, as started in the way specified in the example (tendermint init, tendermint node) seems to expect the example to run on port 26658 rather than 46658 (also referenced here: Should this basic example work on version Tendermint Version 0.15? #18)
  3. Not really an inconsistency, but couldn't figure out why it's so: require('abci') is not going to work in examples/counterjs, unless abci is linked as a module; perhaps it should be require('..') so it can run for people who are trying to follow the tutorial?

EDIT: For some reason I thought abci was not on npmjs, that was my mistake; I still think that the tutorial should "work" when you follow it step by step, so this should be addressed in some way; perhaps add npm link in the tutorial or something

zramsay added a commit to tendermint/tendermint that referenced this issue Jun 25, 2018
@zramsay
Copy link
Contributor

zramsay commented Jun 25, 2018

Thanks for reporting these issues. Points 1 and 2 fixed with the above commits/PRs. @mappum can address point 3

@zramsay zramsay mentioned this issue Jun 25, 2018
@Ivshti
Copy link
Author

Ivshti commented Jun 25, 2018

thanks for the quick fixes!

regarding point 3, I just edited my issue report cause I realized abci is actually published

@mappum mappum closed this as completed in a113f03 Jun 26, 2018
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

2 participants