Important: This is the documentation for a previous version of Feathers.
For the latest documentation please visit docs.feathersjs.com.
We will start with writing snippets of Feathers code by hand. We'll take a step by step approach, introducing a few new concepts each time.
Each step is backed by a working example in the
examples/step/ folder of the docs.
The code samples in this guide are extracts from those examples.
Code snippets may be ambiguous, misleading or confusing.
Working examples reduce these problems,
and let you learn more by modifying them yourself.
One example may continue with changes from a previous example. In such cases, a summary of the differences between the two examples may be shown to help you understand the changes.
Warning. The clients in the examples log results to the browser console. So open the console log before pointing the browser at an example URL.
Feathers has a definite a-ha! moment, that moment when you realize how much it accomplishes and how simply. We want to get to that moment quickly, while fully understanding what is happening.
We'll develop a solid enough understanding of Feathers basics that, by the time we get to Feathers' generators, we'll be mostly interested in how they structure projects rather than in the code they produce.
Our intended audience
This guide should be a comfortable introduction to Feathers for people learning new technologies, such as those coming from PHP, Ruby, or Meteor.
It may be productive for seasoned developers, experienced in Node, REST and WebSockets, to skim the text, paying more attention to the code extracts.
They should however make sure to absorb fully the Generators section. That should save them some time compared to putting together their own understanding of how projects are structured.