Skip to content

Commit 62f45e0

Browse files
committed
Readme formatting test
1 parent 404af33 commit 62f45e0

File tree

2 files changed

+25
-11
lines changed

2 files changed

+25
-11
lines changed

README.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,6 @@ Code examples are available for each chapter, and you can run them all with `yar
2727

2828
**Every chapter contains the code of previous chapters**, so if you are simply looking for a boilerplate project containing everything, just clone the last chapter and you're good to go.
2929

30-
Note: The order of chapters is not necessarily the most educational. For instance, testing / type checking could have been done before introducing React. It is quite difficult to move chapters around or edit past ones, since I need to apply those changes to every following chapter. If things settle down, I might reorganize the whole thing in a better way.
31-
3230
The code of this tutorial works on Linux, macOS, and Windows.
3331

3432
## Table of contents
@@ -51,9 +49,9 @@ React Router, Server-Side Rendering, Styling, Enzyme, Git Hooks.
5149

5250
## Translations
5351

54-
- (**v1**) [中文](https://github.com/pd4d10/js-stack-from-scratch) by [@pd4d10](http://github.com/pd4d10)
55-
- (**v1**) [Italiano](https://github.com/fbertone/js-stack-from-scratch) by [Fabrizio Bertone](https://github.com/fbertone)
56-
- (**v1**) [日本語](https://github.com/takahashim/js-stack-from-scratch) by [@takahashim](https://github.com/takahashim)
52+
- (**Tutorial v1.0.0**) [中文](https://github.com/pd4d10/js-stack-from-scratch) by [@pd4d10](http://github.com/pd4d10)
53+
- (**Tutorial v1.0.0**) [Italiano](https://github.com/fbertone/js-stack-from-scratch) by [Fabrizio Bertone](https://github.com/fbertone)
54+
- (**Tutorial v1.0.0**) [日本語](https://github.com/takahashim/js-stack-from-scratch) by [@takahashim](https://github.com/takahashim)
5755

5856
If you want to add your translation, please read the [translation recommendations](/how-to-translate.md) to get started!
5957

tutorial/01-node-yarn-package-json/README.md

Lines changed: 22 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,12 @@
1-
# 01 - Node, NPM, Yarn, and package.json
1+
# 01 - Node, NVM, NPM, Yarn, and `package.json`
22

33
In this section we will set up Node, NPM, Yarn, a basic `package.json` file, and try a package.
44

5-
## Installing Node and NPM
5+
## Node
66

7-
First, we need to install Node, which is not only used for back-end JavaScript, but all the tools we need to build a modern Front-End stack.
7+
> 💡 **Node.js** is a JavaScript runtime environment. It is mostly used for Back-End development, but also for general scripting. In the context of Front-End development, it can be used to perform a whole bunch of tasks like linting, testing, and assembling files.
8+
9+
We're going to use Node for basically everything in this tutorial, so you're going to need it.
810

911
Head to the [download page](https://nodejs.org/en/download/current/) for macOS or Windows binaries, or the [package manager installations page](https://nodejs.org/en/download/package-manager/) for Linux distributions.
1012

@@ -17,16 +19,30 @@ sudo apt-get install -y nodejs
1719

1820
You want any version of Node > 6.5.0.
1921

20-
`npm`, the default package manager for Node, comes automatically with Node, so you don't have to install it yourself.
22+
## NVM
23+
24+
If Node is already installed, or if you want more flexibility, install `nvm` ([Node Version Manager](https://github.com/creationix/nvm)), make `nvm` install and use the latest version of Node for you.
25+
26+
## NPM
2127

22-
**Note**: If Node is already installed, or if you want more flexibility, install `nvm` ([Node Version Manager](https://github.com/creationix/nvm)), make `nvm` install and use the latest version of Node for you.
28+
> 💡 **NPM** is the default package manager for Node. It is automatically installed alongside with Node. Package managers are used to install and manage packages (modules of code that you or someone else wrote).
29+
30+
We are going to use a lot of packages in this tutorial, but we won't be using NPM
2331

2432
## Yarn
2533

26-
[Yarn](https://yarnpkg.com/) is another package manager which is much faster than NPM, has offline support, and fetches dependencies [more predictably](https://yarnpkg.com/en/docs/yarn-lock). Since it [came out](https://code.facebook.com/posts/1840075619545360) in October 2016, it received a very quick adoption and is becoming the new package manager of choice of the JavaScript community. We are going to use Yarn in this tutorial. If you want to stick to NPM you can simply replace all `yarn add` and `yarn add --dev` commands of this tutorial by `npm install --save` and `npm install --dev`.
34+
> 💡 **[Yarn](https://yarnpkg.com/)** is another package manager which is much faster than NPM, has offline support, and fetches dependencies [more predictably](https://yarnpkg.com/en/docs/yarn-lock).
35+
36+
Since it [came out](https://code.facebook.com/posts/1840075619545360) in October 2016, it received a very quick adoption and is becoming the new package manager of choice of the JavaScript community. We are going to use Yarn in this tutorial. If you want to stick to NPM you can simply replace all `yarn add` and `yarn add --dev` commands of this tutorial by `npm install --save` and `npm install --dev`.
2737

2838
- Install Yarn by following the [instructions](https://yarnpkg.com/en/docs/install). You can likely install it with `npm install -g yarn` or `sudo npm install -g yarn` (yeah, we're using NPM to install Yarn, much like you would use Internet Explorer or Safari to install Chrome!).
2939

40+
41+
42+
43+
44+
45+
3046
## package.json, Hello World, start script
3147

3248
- Create a new folder to work in, and `cd` in it.

0 commit comments

Comments
 (0)