felixge / nodeguide.com

My unofficial and opinionated guide to node.js.

nodeguide.com

Local installation

git clone [email protected]:felixge/nodeguide.com.git
cd nodeguide.com 

Viewing the Guide

With Docker

If you don't know what Docker is, then it will be easiest for you to view the Without Docker instructions, below.

If you do not have a webserver (Apache/ Nginx) running, you will probably have port 80 available, in which case just run:

docker-compose up

If, however port 80 is already taken by a webserver (typical for a development environment), you will see an error like this: Error starting userland proxy: listen tcp 0.0.0.0:80: listen: address already in use. In which case, you can use the "override" file to make it use a different port (e.g. 8080 if that is available):

cp docker-compose.override.yml.dist docker-compose.override.yml
docker-compose -f docker-compose.override.yml up

Without Docker - Debian/ Ubuntu

You can run these commands to view the guide locally, temporarily.

sudo apt install pandoc # if you don't yet have pandoc installed
make

Technology	Command Line
PHP	php -S localhost:8000
Python	python -m SimpleHTTPServer 8000
Python - twistd	twistd -n web -p 8080 --path .
Ruby	ruby -run -ehttpd . -p8080

Then visit: http://localhost:8000

See Also

• Docker
• Pandoc

nodeguide.com's Issues

Dead link

The link to fabjs in the beginner's guide is dead, it is some "financial blog" now.

Minor typos

On the beginner page, in the installation section:

$ wget http://nodejs.org/dist/node-v0.4.4.tar.gz

$ tar -xzf node-v0.4.4.tar.gz

$ cd node-v0.4.4.tar.gz

$ ./configure

$ sudo make install

I think it would be better to use something such as node-v0.x.x.tar.gz so that it's less obvious that the displayed version is outdated.
Also, cd node-v0.4.4.tar.gz should be cd node-v0.4.4/ (or cd node-v0.x.x/).

Cheers,
Dennis

Untitled

small typo in docs.

http://nodeguide.com/beginner.html#installation

cd node-v0.4.4.tar.gz

should be:

cd node-v0.4.4

Add forever to the deployment section.

While not perfect, forever provides a good way of avoiding the use of screen in deployment on personal servers. More info here: https://github.com/nodejitsu/forever

Style code bug

Maybe it's intentional - the 'Wrong' section in Return-statements is not just bad style, but won't work as expected. The first if condition should probably read 'val >= 0' instead of 'val < 0'.

First program hello_world.js

It's not much of an issue but for the first program it should be

node hello_world.js
not node hello.js

http://nodeguide.com/beginner.html

RSS Feed

Please-please add an rss feed to nodeguide.com so we don't miss another guide :)

nodeguide.com not up anymore

page not up anymore?

Web page not responsive

My monitor is in portrait position, so I rely on responsive web layout to read comfortably. However on nodeguides.com, the texts were overflowing my display screen which required me to scroll right every time I hit line-ends. I ended up printing the docs on paper. Overall, I liked the plain layout.

Code Conventions / Var declaration

I've read your comment about Crockforf and followed the link and he also says to use var the same way as you do :-)
"It is preferred that each variable be given its own line and comment. They should be listed in alphabetical order.

var currentEntry; // currently selected table entry
var level;        // indentation level
var size;         // size of table

"
I copied this code to JSLint and it passes. Seems Crockford changed his mind :-)

Felix's Node.js Style Guide > Quotes > SQL

s/Use single quotes, unless you are writing JSON./Use single quotes, unless you are writing JSON or SQL./

«Hello World Tutorial» needs an update

«Hello World Tutorial» currently says:

You should run a *nix operating system in order to use node.js at this point. Linux and OSX are recommended, but you should also be able to use FreeBSD and cygwin (on windows). A full windows port of node.js is in the works, but it is not yet ready for public usage.

A full windows port of node.js is already more or less complete.

Trivial issue

Hey Felix - thanks for the effort you put into the style guide.

Under Array/Object Creation you'll find a trailing comma..

var a = ['hello', 'world'];
var b = {
good: 'code',
'is generally': 'pretty',
};

Wrong function on 'A hello world http server'

On the first HTTP server example the function 'sendHead()' i guess it should be 'writeHead()'.

typo in node beginner's guide (s/data/req)

In first example under EventEmitters:

var data = '';
req
  .on('data', function(chunk) {
    data += chunk;
  })
  .on('end', function() {
    console.log('POST data: %s', data);
  })

Shouldn't that first line be a declaration of 'req' not 'data'?

thanks for the helpful docs!

Small Typo

Hi Felix, wonderful guide!
I noticed in the Style guide under Braces there is a missing quote after winning.

Better twitter search parameter

In Community Guide, Twitter search support 'OR' operator, so we can make a better search phrase:

http://search.twitter.com/search?q=%23nodejs%20OR%20node.js