You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: prerequisites.md
+38-24Lines changed: 38 additions & 24 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,22 +5,36 @@
5
5
-[Install Node.js](#InstallNodeJs)
6
6
-[Install a code editor](#InstallCodeEditor)
7
7
-[Get the sources](#GetTheSources)
8
-
8
+
9
9
10
10
<aname="FamiliarWithGit"></a>
11
11
## Familiar with git?
12
12
13
-
Note that, if you do not have git installed already, you can get it from here: [Windows](https://windows.github.com/), [Mac OSX](https://mac.github.com/), and [Linux](http://git-scm.com/download/linux).
14
-
And get additional setup instructions [here](https://help.github.com/articles/set-up-git).
13
+
[Git](http://www.git-scm.com) is a free and open source distributed version control system.
14
+
It enables teams to work together efficiently, all using the same files.
15
+
16
+
It also helps teams cope with the confusion that can happen when multiple people are editing the same files.
17
+
18
+
This tutorial is hosted on GitHub, a Git repository hosting service, that also adds many of its own additional features.
19
+
20
+
While Git is a command line tool, GitHub provides a Web-based graphical interface and a GUI tools.
21
+
22
+
It also provides access control and several collaboration features, such as a Wiki and basic task management tools for every project.
23
+
24
+
If you do not have git installed already, you can get it from here:
25
+
26
+
-[Windows](https://windows.github.com)
27
+
-[Mac OSX](https://mac.github.com)
28
+
-[Linux](http://git-scm.com/download/linux)
15
29
16
-
Git allows a team of people to work together, all using the same files. And it helps the team cope with the confusion that tends to happen when multiple people are editing the same files.
17
-
GitHub is a Git repository hosting service, but it adds many of its own features. While Git is a command line tool, GitHub provides a Web-based graphical interface and a GUI tools. It also
18
-
provides access control and several collaboration features, such as a wikis and basic task management tools for every project..
30
+
Here are some [additional setup instructions](https://help.github.com/articles/set-up-git), and many other questions are covered by the [GitHub Help](https://help.github.com).
19
31
20
32
Here is a [github quick learning tutorial](https://try.github.io/levels/1/challenges/1) if you never used git before. Note it is a command line tutorial, but you may prefer the GUI or WEB interfaces.
21
33
22
-
If you have a GitHub client ([GitHub for Windows](https://windows.github.com/) or [GitHub for Mac](https://mac.github.com/)) installed, you can clone
23
-
a repository from GitHub. Go to the the repository you want to download locally and clone the source code by clicking the 'Clone in Desktop' button.
34
+
Once you have a GitHub client installed, you can clone
35
+
a repository from GitHub.
36
+
37
+
Go to the the repository you want to download locally and clone the source code by clicking the 'Clone in Desktop' button.
24
38
25
39

26
40
@@ -33,15 +47,15 @@ Your repository git url can be obtain from the 'HTTPs clone URL' box.
33
47
34
48

35
49
36
-
This creates the a copy of all the source of the repository on your local drive. In this 'clone' directory, you can find the files from the repository which you can work with.
37
-
However, it is important to note here that unless you got write permission, you would not be able to save your changes in the repo. To be able to save in the repo you clone,
38
-
you either need to be a contributor on that repo, or have cloned one of your own repo. If you want to work from someone else repo, and be able to edit and save your changes,
50
+
This creates the a copy of all the source of the repository on your local drive. In this 'clone' directory, you can find the files from the repository which you can work with.
51
+
However, it is important to note here that unless you got write permission, you would not be able to save your changes in the repo. To be able to save in the repo you clone,
52
+
you either need to be a contributor on that repo, or have cloned one of your own repo. If you want to work from someone else repo, and be able to edit and save your changes,
39
53
please consider to 'fork' the repo in your account, and clone that repo instead from your account. See below instructions [how to fork a repo](#Fork).
40
54
41
55
If you prefer not to install git, you can download a zip file instead by clicking the 'Download ZIP' button.
42
56
43
57

44
-
58
+
45
59
In this workshop, we will provide the command line instructions, but feel free to use the method you prefer.
46
60
47
61
@@ -82,8 +96,8 @@ Either checkout a tag version or a branch. Updates files in the working tree to
82
96
### git command line
83
97
84
98
Using git from the command line on Mac OSX or Linux is straight forward, just open a terminal window (on Mac OSx - Applications -> Utilities -> Terminal.app). git, node, and npm commands should work from there if present on your system.
85
-
On Windows, you can choose between few options: a bash console, a powershell console, or the standard command prompt. You can decide which one to use from the Github tool in the settings panel.
86
-
You would access the git console by running the 'Git Shell' icon which should be on your Desktop or in your Programs list. Node and npm commands have their own command prompt window which is
99
+
On Windows, you can choose between few options: a bash console, a powershell console, or the standard command prompt. You can decide which one to use from the Github tool in the settings panel.
100
+
You would access the git console by running the 'Git Shell' icon which should be on your Desktop or in your Programs list. Node and npm commands have their own command prompt window which is
87
101
different from GitHub.
88
102
89
103
@@ -94,7 +108,7 @@ Last, someone may want to work on the wokshop and saves this results on his own
94
108
To fork a repository, log in Github using your account, go to the repository you want to fork, and press the 'Fork' button.
95
109
96
110

97
-
111
+
98
112
99
113
<aname="InstallNodeJs"></a>
100
114
## Install Node.js
@@ -119,7 +133,7 @@ If you need to run different versions of node.js in your local environment, cons
119
133
<aname="InstallCodeEditor"></a>
120
134
## Install a code editor
121
135
122
-
If you have programmed before, you may already have a favorite programmer's editor. However, if you do not, or were thinking about trying other editors anyway,
136
+
If you have programmed before, you may already have a favorite programmer's editor. However, if you do not, or were thinking about trying other editors anyway,
123
137
spend some time trying and considering these options common in the javascript/node.js community ...
124
138
125
139
Note, they are not listed in the order of preference.
@@ -133,13 +147,13 @@ Note, they are not listed in the order of preference.
133
147
[textmate](http://macromates.com/) | - | X | - | Paid
134
148
[Sublime Text](http://www.sublimetext.com/) | X | X | X | Paid
135
149
[WebStorm](https://www.jetbrains.com/webstorm/) | X | X | X | Paid
136
-
150
+
137
151
138
152
<aname="GetTheSources"></a>
139
153
## Get the sources
140
154
141
-
We assume you want to start a project and work as a team. For this reason, you want to use 'git' and be able to share the sources across the members of your team,
142
-
and later deploy it on a web server. Your first action will be to fork the material repository on your 'github' account.
155
+
We assume you want to start a project and work as a team. For this reason, you want to use 'git' and be able to share the sources across the members of your team,
156
+
and later deploy it on a web server. Your first action will be to fork the material repository on your 'github' account.
143
157
If you prefer not to use git, you can still download the zip files and inflate their contents on your local drive.
144
158
145
159
* Using git
@@ -150,10 +164,10 @@ If you prefer not to use git, you can still download the zip files and inflate t
150
164
- In the git console, run the following commands:<br />
151
165
```
152
166
git clone <your HTTPS clone URL>
153
-
167
+
154
168
git checkout v1.0-workshop
155
169
```
156
-
The first command creates the workflow-node.js-view.and.data.api in your current directory. The second command is optional and is there to make sure we work on
170
+
The first command creates the workflow-node.js-view.and.data.api in your current directory. The second command is optional and is there to make sure we work on
157
171
the correct version of the material made for this instructions.
158
172
- Change your working directory <br />
159
173
```
@@ -165,12 +179,12 @@ If you prefer not to use git, you can still download the zip files and inflate t
165
179
- Download the ZIP file from [here](https://github.com/Developer-Autodesk/workflow-node.js-view.and.data.api/releases/tag/v1.0-workshop)
166
180
- Inflate the ZIP file on your hard drive
167
181
- Make the inflated directory your current directory
168
-
182
+
169
183
170
184
The tutorial instructions, from now on, assumes you are running all commands from the *workflow-node.js-view.and.data.api* directory.
0 commit comments