Our first Feathers application

Now that we are set up we can create our first Feathers application. It will work in both, NodeJS and the browser. First, let's create a new folder for all our examples to run in:

mkdir feathers-basics
cd feathers-basics

Since any Feathers application is a Node application, we can create a default package.json using npm:

npm init --yes

Installing Feathers

Feathers can be installed like any other Node module by installing the @feathersjs/feathers package through npm. The same package can also be used with a module loader like Browserify or Webpack and React Native.

npm install @feathersjs/feathers --save

Note: All Feathers core modules are in the @feathersjs npm namespace.

Your first app

The base of any Feathers application is the app object which can be created like this:

const feathers = require('@feathersjs/feathers');
const app = feathers();

This application object has several methods, most importantly it allows us to register services. We will learn more about services in the next chapter, for now let's register and use a simple service that has only a get method by creating an app.js file (in the current folder) like this:

const feathers = require('@feathersjs/feathers');
const app = feathers();

// Register a simple todo service that return the name and a text
app.use('todos', {
  async get(name) {
    // Return an object in the form of { name, text }
    return {
      name,
      text: `You have to do ${name}`
    };
  }
});

// A function that gets and logs a todo from the service
async function getTodo(name) {
  // Get the service we registered above
  const service = app.service('todos');
  // Call the `get` method with a name
  const todo = await service.get(name);

  // Log the todo we got back
  console.log(todo);
}

getTodo('dishes');

We can run it with

node app.js

And should see

{ name: 'dishes', text: 'You have to do dishes' }

Pro tip: For more information about the Feathers application object see the Application API documentation.

In the browser

The Feathers application we created above can also run just the same in the browser. The easiest way to load Feathers here is through a <script> tag pointing to the CDN version of Feathers. Loading it will make a feathers global variable available.

Let's put the browser files into a new folder

mkdir public

We will also need to host the folder with a webserver. This can be done with any webserver like Apache or with the http-server module that we can install and host the public/ folder like this:

npm install http-server -g
http-server public/

Note: You have to keep this server running for all browser examples in the basics guide to work.

In the public/ folder we add two files, an index.html that will load Feathers:

<!DOCTYPE html>
<html lang="en">
<head>
  <meta charset="UTF-8">
  <title>Feathers Basics</title>
</head>
<body>
  <h1>Welcome to Feathers</h1>
  <p>Open up the console in your browser.</p>
  <script type="text/javascript" src="//unpkg.com/@feathersjs/client@^3.0.0/dist/feathers.js"></script>
  <script src="client.js"></script>
</body>
</html>

And an client.js looking like this:

const app = feathers();

// Register a simple todo service that return the name and a text
app.use('todos', {
  async get(name) {
    // Return an object in the form of { name, text }
    return {
      name,
      text: `You have to do ${name}`
    };
  }
});

// A function that gets and logs a todo from the service
async function logTodo(name) {
  // Get the service we registered above
  const service = app.service('todos');
  // Call the `get` method with a name
  const todo = await service.get(name);

  // Log the todo we got back
  console.log(todo);
}

logTodo('dishes');

You may notice that it is pretty much the same as our app.js for Node except the missing feathers import (since it is already available as a global variable).

If you now go to localhost:8080 with the console open you will also see the result logged.

Note: You can also load Feathers with a module loader like Webpack or Browserify. For more information see the client API chapter.

What's next?

In this chapter we created our first Feathers application with a simple service that works in Node and the browser. Next, let's learn more about Services and Service events.

Is anything wrong, unclear, missing? Leave a comment or edit this page.

results matching ""

    No results matching ""