tdreid / feathers-guide

Introductory guide to Feathersjs (work in progress)

feathers-guide

Installing the guides and examples

Install Node

Node is a server platform which runs JavaScript. Its lightweight and efficient. It has the largest ecosystem of open source libraries in the world.

• Default install.
• Specfic versions.

Install git

git is the version control system most frequently used in open source. There are many resources available for installing it.

• Linux.
• Mac OSX.
• Windows.

Install the guide and its examples

Linux and Windows:

cd the/folder/above/which/you/want/the/guide/to/reside
git clone https://github.com/feathersjs/feathers-guide

Mac OSX:

// todo ******************

Alternative install. If you don't already have git installed on your machine, you may prefer to download the repository as a zip file. Point your browser at https://github.com/feathersjs/feathers-guide/archive/master.zip to start the download.

Install dependencies

cd ./feathers-guide
npm install

Reading the guide

You can read the guide by serving the static files at feathers-guide/_book.

If you do not have a static server already installed, you may install http-server globally with npm install http-server -g and start serving the guide with:

cd feathers-guide
http-server

Then point your browser at http://localhost:8080/_book.

Recreating the examples used in the guides

Each guide is divided into sections, each section backed by working examples in examples/. The code samples in the guides are extracts from those examples. Code snippets may be ambiguous, misleading or confusing. Working examples reduce these problems, as well as letting you learn more by modifying them yourself.

One example may continue with changes from a previous example. In such cases, a recap of the differences between the 2 examples may be shown to help in understanding the changes.

The guides go into details about how each example was created. You can recreate the process yourself if that helps your learning process. Create a folder called, say, copy-an-introduction with a subfolder examples/. You can run the same commands as mentioned in the guide and (hopefully!) get the same results.

License

Copyright (c) 2016-2017

Licensed under the MIT license.

Is anything wrong, unclear, missing?

Leave a comment.