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: TUTORIAL.md
+21-21
Original file line number
Diff line number
Diff line change
@@ -2,7 +2,7 @@
2
2
3
3
The Node Package Manager (NPM) is a command-line tool used by developers to share and control modules (or packages) of JavaScript code written for use with Node.js.
4
4
5
-
## L1 Intro
5
+
## 1. Intro
6
6
7
7
> Introduction to the package.json
8
8
@@ -18,7 +18,7 @@ Most developers prefer to install packages local to each project to create a sep
18
18
The `package.json` file is the center of any Node.js project or NPM package. It stores information about your project, similar to how the <head> section of an HTML document describes the content of a webpage. It consists of a single JSON object where information is stored in key-value pairs. There are only two required fields; "name" and "version", but it’s good practice to provide additional information about your project that could be useful to future users or maintainers.
19
19
If you look at the file tree of your project, you will find the package.json file on the top level of the tree. This is the file that you will be improving in the next couple of challenges.
20
20
21
-
## L2 Author
21
+
## 2. Author
22
22
23
23
> Package.json author
24
24
@@ -28,12 +28,12 @@ One of the most common pieces of information in this file is the `author` field.
28
28
"author": "Jane Doe",
29
29
```
30
30
31
-
### L2S1
31
+
### 2.1
32
32
33
33
Add your name as the `author` of the project in the package.json file.
34
34
**Note:** Remember that you’re writing JSON, so all field names must use double-quotes (") and be separated with a comma (,).
35
35
36
-
## L3 Description
36
+
## 3. Description
37
37
38
38
> Package.json description
39
39
@@ -48,13 +48,13 @@ Here's an example:
48
48
"description": "A project that does something awesome",
49
49
```
50
50
51
-
### L3S1
51
+
### 3.1
52
52
53
53
Add a `description` to the package.json file of your project.
54
54
55
55
**Note:** Remember to use double-quotes for field-names (") and commas (,) to separate fields.
56
56
57
-
## L4 Keywords
57
+
## 4. Keywords
58
58
59
59
> Package.json keywords
60
60
@@ -68,13 +68,13 @@ Here's an example:
68
68
69
69
As you can see, this field is structured as an array of double-quoted strings.
70
70
71
-
### L4S1
71
+
### 4.1
72
72
73
73
Add an array of suitable strings to the `keywords` field in the package.json file of your project.
74
74
75
75
One of the keywords should be "freecodecamp".
76
76
77
-
## L5 License
77
+
## 5. License
78
78
79
79
> Package.json license
80
80
@@ -86,11 +86,11 @@ Some common licenses for open source projects include MIT and BSD. License infor
86
86
"license": "MIT",
87
87
```
88
88
89
-
### L5S1
89
+
### 5.1s
90
90
91
91
Fill the `license` field in the package.json file of your project as you find suitable.
92
92
93
-
## L6 Version
93
+
## 6. Version
94
94
95
95
> Package.json version
96
96
@@ -100,11 +100,11 @@ A `version` is one of the required fields of your package.json file. This field
100
100
"version": "1.2.0",
101
101
```
102
102
103
-
### L6S1
103
+
### 6.1
104
104
105
105
Add a `version` to the package.json file of your project.
106
106
107
-
## L7 External Packages
107
+
## 7. External Packages
108
108
109
109
> Installing dependencies from NPM
110
110
@@ -129,13 +129,13 @@ npm install express
129
129
130
130
Installed packages are created in a `node_modules` folder in your project. Avoid editing or changing the node_modules folder or its contents.
131
131
132
-
### L7S1
132
+
### 7.1
133
133
134
134
Install the "moment" package to the `dependencies` field of your package.json file by running the command line npm install.
135
135
136
136
**Note:** Moment is a handy library for working with time and dates.
137
137
138
-
## L8 Semantic Versioning
138
+
## 8. Semantic Versioning
139
139
140
140
> Versioning packages
141
141
@@ -160,11 +160,11 @@ Using the NPM cli, a specific version of a package can be installed by specifyin
160
160
npm install express@4.17.0
161
161
```
162
162
163
-
### L8S1
163
+
### 8.1
164
164
165
165
In the dependencies section of your package.json file, change the `version` of moment to match MAJOR version 2, MINOR version 10 and PATCH version 2
166
166
167
-
## L9 Receive Patch Updates
167
+
## 9. Receive Patch Updates
168
168
169
169
> Using `~` to recieve patches
170
170
@@ -176,14 +176,14 @@ To allow an npm dependency to update to the latest PATCH version, you can prefix
176
176
"package": "~1.3.8"
177
177
```
178
178
179
-
### L9S1
179
+
### 9.1
180
180
181
181
In the package.json file, your current rule for how npm may upgrade moment is to use a specific version (2.10.2). But now, you want to allow the latest 2.10.x version.
182
182
Use the tilde (`~`) character to prefix the version of moment in your dependencies, and allow npm to update it to any new PATCH release.
183
183
184
184
**Note:** The version numbers themselves should not be changed.
185
185
186
-
## L10 Receive Minor Updates
186
+
## 10. Receive Minor Updates
187
187
188
188
> Using `^` to receive minor updates
189
189
@@ -197,13 +197,13 @@ Your current version of moment should be "~2.10.2" which allows npm to install t
197
197
198
198
This would allow updates to any 1.x.x version of the package.
199
199
200
-
### L10S1
200
+
### 10.1
201
201
202
202
Use the caret (`^`) to prefix the version of moment in your dependencies and allow npm to update it to any new MINOR release.
203
203
204
204
**Note:** The version numbers themselves should not be changed.
205
205
206
-
## L11 Remove a Dependency
206
+
## 11. Remove a Dependency
207
207
208
208
> Removing a dependency
209
209
@@ -213,7 +213,7 @@ But what if you want to remove an external package that you no longer need? You
213
213
214
214
This same method applies to removing other fields in your package.json as well.
0 commit comments