Skip to content

Commit

Permalink
[docs] update requirements
Browse files Browse the repository at this point in the history
  • Loading branch information
jchip committed Jul 30, 2017
1 parent 967b653 commit 54e79b7
Showing 1 changed file with 46 additions and 14 deletions.
60 changes: 46 additions & 14 deletions docs/overview/requirements.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,24 +5,56 @@ First, let's quickly check your development environment. You will need to have t
## For Development On Your Local machine

1. Install the latest [NodeJS LTS binary](https://nodejs.org/) in your machine. (at least v4.2 required, >= 6 recommended).
- Recommend a tool like [nvm](https://github.com/creationix/nvm#install-script) for managing NodeJS installations.
2. Install latest (v3) of [npm](https://www.npmjs.com/) with `npm install -g npm`.
- Note: NodeJS v6.x already comes with npm@3 by default.
- **Electrode requires npm version >= 3**
3. Install [yo] with `npm install -g yo`.
4. Install [generator-electrode] with `npm install -g generator-electrode`.
5. Install [xclap] with `npm install -g xclap-cli`.
6. The text editor of your choice downloaded with CLI tools installed.

> **We write NodeJS code with ES6 features that NodeJS >= 4.2 supports.**
>
> yo is a generic scaffolding system allowing the creation of any kind of app.
> generator-electrode is a generator for Universal React App with NodeJS backend or a React component with useful clap tasks for development, building and publishing.
> xclap is a Javascript build tool that lets us automate tasks.

- We recommend a tool like [nvm](https://github.com/creationix/nvm#install-script) for managing NodeJS installations, but see [info here](#globally-installed-nodejs) for cautionary notes.

2. Install [yo], [generator-electrode], and [xclap-cli] globally:

```bash
npm install -g yo generator-electrode xclap-cli
```

### Globally Installed NodeJS

IMPORTANT: If you install NodeJS globally on your system, then please make sure you only use that version. [yeoman] appears to always lookup generators from your system folders so very strange things will happen if you try to use another version of NodeJS through nvm but also have a [generator-electrode] installed in your system folders.

Basically, bad things happen if you mix NodeJS installations with [nvm] and the system installer. Our recommendation is to either:

- Do not install a copy of NodeJS on your system and only use nvm to manage NodeJS.

or

- Only use your NodeJS installed globally on your system.

### Keep generator-electrode Up to date

We release new version of [generator-electrode] when we add new features. So make sure you check the versions and update it periodically with the command:

```bash
npm install -g generator-electrode
```

### npm Verion 3

**Electrode requires npm version >= 3**

NodeJS v6.x already comes with npm@3 by default, but if you are using NodeJS 4 for some reason, make sure you install npm@3 with the following command:

```bash
npm install -g npm@3
```

## For Online Deployments

- A [Heroku](https://signup.heroku.com/dc) account + [CLI tools](https://devcenter.heroku.com/articles/heroku-command-line).
- A [Github](https://github.com/) account.

Ready? Let's [build](/chapter1/quick-start/build-component.md).

[yo]: http://yeoman.io/

[yeoman]: http://yeoman.io/

[xclap-cli]: https://www.npmjs.com/package/xclap-cli

[generator-electrode]: https://www.npmjs.com/package/generator-electrode

0 comments on commit 54e79b7

Please sign in to comment.