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

docs(dev): improve dev setup instructions #468

Open
wants to merge 3 commits into
base: v4
Choose a base branch
from

Conversation

justmoon
Copy link
Contributor

Several improvements to the development setup instructions:

  • Change clone command to use v4 branch.
  • Create an npm run install-all shortcut command instead of manually cd-ing and installing.
  • Add a hint to use the wallet1.com hostname when running npm run configure.
  • Add note that you may have to use sudo to run the proxy.
  • Add npm install for the proxy webserver.
  • Make it more clear that you only need to follow one of the two local forwarding sections.
  • Add a "next step" for what to do after installation.

Several improvements to the development setup instructions:

* Change clone command to use `v4` branch.
* Create an `npm run install-all` shortcut command instead of manually cd-ing and installing.
* Add a hint to use the wallet1.com hostname when running `npm run configure`.
* Add note that you may have to use sudo to run the proxy.
* Add npm install for the proxy webserver.
* Make it more clear that you only need to follow one of the two local forwarding sections.
* Add a "next step" for what to do after installation.
@sentientwaffle
Copy link
Contributor

What do you think of running install-all during ilp-kit's installation (i.e. as a postinstall hook of the top-level package)?

@justmoon
Copy link
Contributor Author

justmoon commented Sep 5, 2017

What do you think of running install-all during ilp-kit's installation (i.e. as a postinstall hook of the top-level package)?

I think that's a good idea!

@justmoon
Copy link
Contributor Author

justmoon commented Sep 5, 2017

For future reference: If anyone needs an install without the postinstall script, you can run npm install --ignore-scripts

@vhpoet
Copy link
Contributor

vhpoet commented Sep 13, 2017

can we merge this? @justmoon

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

Successfully merging this pull request may close these issues.

None yet

3 participants