Skip to content

Add git clone suggestion #1319

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

Open
wants to merge 8 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 20 additions & 4 deletions docs/InstallingTheKit/InstallingTheKit.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,17 +6,33 @@ There is no failure except when nothing is learned.

## Clone from github

First you should clone the project from GitHub. The easiest way is to use something like this:
First you should clone the project from GitHub. The easiest way is to use something like this. Say you want to call your app <YOUR_APP_NAME>:

![Cloning from GitHub](git_clone.png)
```bash
git clone [email protected]:erikras/react-redux-universal-hot-example.git \
-o react-redux-universal-hot-example <YOUR_APP_NAME>
cd <YOUR_APP_NAME>
```

This puts a copy of the whole project into your directory `mycopy`. All the files you will change are
in this directory. You can `rm -rf mycopy`, clone it again, and continue on.
This puts a copy of the whole project into your directory `<YOUR_APP_NAME>`. All the files you will change are
in this directory. You can `rm -rf <YOUR_APP_NAME>`, clone it again, and continue on.

That's the minimum view of git, equivalent to the [xkcd view](https://xkcd.com/1597/). Git and
[github](https://github.com) make every manipulation and automated workflow possible but none easy.
Nothing more complex than creating new copy is necessary until contributing code to a project.

Note: You'll probably want to have your own Git repo somewhere like github to keep your own updates safe.

To do that:

* First create the empty (no README.md or any other files) repo on [github.com](https://github.com)

* Then add it as the ``origin`` remote locally

```bash
git remote add origin [email protected]:<YOUR_GITHUB_USERNAME>/<YOUR_APP_NAME>.git
```


## Run npm install

Expand Down
Binary file removed docs/InstallingTheKit/git_clone.png
Binary file not shown.