feathers-horizon

Horizon.js feathers plugin, this plugin will start an horizon server instance using provided options or defaults feathers config.

Goals

Plugins intent to add missing horizon.js functionality by leveraging the excellent featherjs for backend. It uses feathers authentication for local strategy

This grants you the entire featherjs ecosystem around your horizon.js application

Thank you

Made possible and inspired by the generous tailsu and his Demo: third-party authentication for horizon

Roadmap

• [x] 0.x - proof of concept - launch horizon in feather using application configuration .
• [ ] 1.0 - Better test coverage, error handling and full options.
• [ ] 2.0 - Add horizon client for server side reactive queries.
• [ ] 3.0 - Add user copy on auth hooks in case of non rethinkdb feather app.

Installation

npm install feathers-horizon --save

Options (optionnal, will refer to feathers-configuration if provided)

Options that can be passed to the Horizon server constructor are identical to the similarly-named options that can be defined in the configuration file, with the same defaults:

• project_name: 'horizon'
• rdb_host: 'localhost'
• rdb_port: 28015
• auto_create_collection: false
• auto_create_index: false
• permissions: true
• path: '/horizon'
• auth:
  • duration: '1d'
  • new_user_group: 'authenticated'
  • token_secret: null
  • allow_anonymous: false
  • allow_unauthenticated: false

Create your app using feathers generators

feathers generate app
feathers generate authentication
npm install feathers-horizon --save

Then import and configure the plugin after Authentication plugin

...
const feathersHorizon = require('feathers-horizon');
...
app.configure(authentication);
app.configure(feathersHorizon());
...

Complete Example

Here's an example of a Feathers server that uses feathers-horizon.

const path = require('path');
const favicon = require('serve-favicon');
const compress = require('compression');
const cors = require('cors');
const helmet = require('helmet');
const bodyParser = require('body-parser');

const feathers = require('feathers');
const configuration = require('feathers-configuration');
const hooks = require('feathers-hooks');
const rest = require('feathers-rest');
const socketio = require('feathers-socketio');
const feathersHorizon = require('feathers-horizon');
const middleware = require('./middleware');
const services = require('./services');
const appHooks = require('./app.hooks');

const authentication = require('./authentication');
const rethinkdb = require('./rethinkdb');
const app = feathers();

// Load app configuration
app.configure(configuration(path.join(__dirname, '..')));
// Enable CORS, security, compression, favicon and body parsing
app.use(cors());
app.use(helmet());
app.use(compress());
app.use(bodyParser.json());
app.use(bodyParser.urlencoded({extended: true}));
app.use(favicon(path.join(app.get('public'), 'favicon.ico')));
// Host the public folder
app.use('/', feathers.static(app.get('public')));

// Set up Plugins and providers
app.configure(hooks());
app.configure(rethinkdb);
app.configure(rest());
app.configure(socketio());
app.configure(services);
app.configure(authentication);
app.configure(feathersHorizon());

// Set up our services (see `services/index.js`) Configure middleware (see
// `middleware/index.js`) - always has to be last
app.configure(middleware);
app.hooks(appHooks);

//Create a default users for our tests. 
var User = {
 email: '[email protected]',
 password: 'admin',
 permissions: ['*']
};

app.service('users')
 .create(User)
 .then(user => {
   console.log('Created default user', user);
 })
  .catch(console.error);
module.exports = app;

License

Copyright (c) 2017

Licensed under the MIT license.