This repository was archived by the owner on Apr 29, 2019. It is now read-only.
README update #88
Merged
README update #88
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Addressing #68 Clarifying Clutter install path and links.
zippy
approved these changes
May 25, 2018
Member
|
Hey @science-girl could you please give my readme edits a once over and then approve? |
science-girl
suggested changes
May 25, 2018
README.md
Outdated
|
|
||
| **--or--**, | ||
|
|
||
| assuming that you've already setup you Holochain environment with [`hcadmin init`](https://developer.holochain.org/Command_Line_Tools#hcadmin_init) you can join and run Clutter with: |
README.md
Outdated
|
|
||
| **Prerequiste:** [Install Holochain](http://developer.holochain.org/Install_Holochain) on your machine and make sure you do the step to set the $GOPATH. | ||
|
|
||
| **Dependencies:** If you want to work on the Clutter UI, you will need `nodejs` (https://nodejs.org/en/) (LTS) installed, with `npm` or `yarn` (https://yarnpkg.com/lang/en/docs/install) to be able to build it from the `ui-src` to the `ui` directory: |
Contributor
There was a problem hiding this comment.
"...to be able to build and copy it from the 'ui-src'..."
| cd clutter/ui-src | ||
| npm install # (or yarn install) | ||
| npm run build # (or yarn build) | ||
| cd .. |
Contributor
There was a problem hiding this comment.
After npm run build, npm start to configure and start the React UI.
README.md
Outdated
| bs | ||
| ``` | ||
| You will get a response like | ||
| You will get a response likev |
README.md
Outdated
| When a branch is pushed to Github Travis runs a build. The build does the following: | ||
| 1. Installs docker-compose | ||
| 2. Runs docker-compose up -d which spins up a bootstrap server and 3 instances of clutter | ||
| 3. Install the cypress dependencies |
Contributor
There was a problem hiding this comment.
For the 3rd point: Install -> Installs
Member
|
done. |
science-girl
approved these changes
May 25, 2018
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Addressing #68 Clarifying Clutter install path and links.