Code Monkey home page Code Monkey logo

docs's Introduction

FeathersJS legacy documentation

Important: This repository contains the documentation for previous versions of FeathersJS.

To read the current documentation please visit feathersjs.com. Documentation for older versions can be found in the version dropdown.

All documentation and code is now available in the monorepo at feathersjs/feathers.

docs's People

Contributors

aral avatar arve0 avatar bartduisters avatar beeplin avatar bertho-zero avatar bravo-kernel avatar claforte avatar claustres avatar clorichel avatar daffl avatar dependabot-preview[bot] avatar designbyonyx avatar eddyystop avatar edwardsmarkf avatar ekryski avatar jayzamazing avatar jciolek avatar jnhghy avatar katopz avatar kulakowka avatar marshallswain avatar mattchewone avatar mitmaro avatar musicformellons avatar osenvosem avatar petermikitsh avatar stevenblack avatar stevenmathews avatar temowemo avatar tryy3 avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

docs's Issues

Outline and progress

Missing chat-app component initalization in the Vue chat example

I know the Vue.js chat example was released yesterday. But when I was playing around with my own vue.js/feathers app.

I wanted to check the vue.js chat example and I noticed that in the example at vue.js https://github.com/feathersjs/feathers-chat/tree/master/public/vue-chat the chat-app is being initalized on line 53 in app.js

But on the guide at http://docs.feathersjs.com/frameworks/vuejs.html I can't see anywhere that you should initalize it.

I haven't really tested the guide myself, but when I was playing around with components on my own, I noticed that you need to initalize them with a template id.

I just started learning vue.js so I could be wrong with components needing to be initialized, so if I am wrong, sorry for taking your time.
I also didn't want to make a pull request incase @niallobrien was working on it and since he wrote it, he has a better idea where the initalization should be in the doc.

Documentation for Setting up Local Authentication is outdated

I found an inaccuracy in the documentation on the page: http://docs.feathersjs.com/authentication/local.html

It is written there:

You'll notice that it currently includes the password. You really don't want it exposed, so when you're ready to secure the service, you'll need an additional feathers-hook to remove the password property from the response.

But when I run the example, the server response does not contain the password.

2016-02-18 23 20 18

It seems this documentation is outdated? Or am I doing something wrong?

I have no more additional hooks for user model.

import globalHooks from '../../../hooks';
import { hooks as auth } from 'feathers-authentication';

let before = {
  all: [],
  find: [],
  get: [],
  create: [auth.hashPassword()],
  update: [],
  patch: [],
  remove: []
};

let after = {
  all: [],
  find: [],
  get: [],
  create: [],
  update: [],
  patch: [],
  remove: []
};

export default { before, after };

And my app.js looks like:

import { join } from 'path';
import { static as serveStatic } from 'feathers';
import favicon from 'serve-favicon';
import compress from 'compression';
import cors from 'cors';
import feathers from 'feathers';
import configuration from 'feathers-configuration';
import hooks from 'feathers-hooks';
import rest from 'feathers-rest';
import bodyParser from 'body-parser';
import socketio from 'feathers-socketio';
import authentication from 'feathers-authentication';
import middleware from './middleware';
import services from './services';

let app = feathers();

app.configure(configuration(join(__dirname, '..')))
  .use(compress())
  .options('*', cors())
  .use(cors())
  .use(favicon( join(app.get('public'), 'favicon.ico') ))
  .use('/', serveStatic( app.get('public') ))
  .use(bodyParser.json())
  .use(bodyParser.urlencoded({ extended: true }))
  .configure(hooks())
  .configure(rest())
  .configure(socketio())
  .configure(authentication( app.get('auth') ))
  .configure(services)
  .configure(middleware)


export default app;

Migrate package docs

Move the bulk of the docs in the README files into this repo and simplify the README on each package.

Packages

  • feathers
  • feathers-commons
  • feathers-rest
  • feathers-socketio
  • feathers-primus
  • feathers-socket-commons
  • feathers-mongodb
  • feathers-mongoose
  • feathers-authentication
  • feathers-client
  • feathers-nedb
  • feathers-memory
  • feathers-sequelize
  • feathers-knex
  • feathers-waterline
  • feathers-query-filters
  • feathers-configuration
  • generator-feathers
  • generator-feathers-plugin

UX after generating an app needs improvement

When you finish generating an app, it shows the message "To start your feathers server run npm start." Since the cli leaves you in a feathers$ prompt, that won't work. We could update the docs or update the generator to show a different message, but the guide doesn't currently reflect exactly what the user is going to experience. It's not that big of a deal, but it's a little detail that some might appreciate. Another option might be to have the cli automatically exit after it finishes.

Woot! We've created your "donejs-feathers-chat" app!
To start your feathers server run `npm start`.
feathers$ npm start

  Invalid Command. Showing Help:

  Commands:

    help [command...]     Provides help for a given command.
    exit                  Exits application.
    generate              alias for generate app
    generate app          generate new application
    generate hook         generate new hook
    generate middleware   generate new middleware
    generate model        generate new model
    generate service      generate new service
    generate plugin       generate new plugin

feathers$ 

Enhance oAuth2 Docs

Copying a detailed explanation from Slack:

@daffl
Basically with Facebook or other oAuth 2 providersbyou link to an endpoint (like /auth/facebook). That one will prompt you to log in and if successful redirect back to the app (your successRedirect endpoint).
For that single request feathers-authentication adds the token you got to a cookie.
feathers-authentication will for that one request throw the generated token into the cookie for the sucessRedirect endpoint. app.authenticate will then either grab the token from the cookie, authenticate you and store the token you get back in localStorage (or whichever storage you choose - in memory by default) or use an existing token from localStorage
Those are the two things client side app.authenticate() will do in that order if you don’t pass any options to it.

I'll do a pull request soon (I hope :P)

Use Babel in the jQuery tutorial

It is using ES6 strings and although it is mentioned at the beginning it was causing confusion for users of older browser. All we have to do is add Babel from the CDN like in the React guide.

Create an "Ecosystem" or "Plugins" page

It should be examples that show how to solve this or that problem.

I for example can show how to make the hook for parsing markdown, slug, virtual attributes and so on.

'use strict'

const hooks = require('feathers-hooks')
const marked = require('../../../../../utils/marked')
const getDomain = require('../../../../../utils/getDomain')
const slug = require('slug')

exports.transform = (hook) => {
  let data = hook.data
  data.slug = slug(data.title.toLowerCase())
  data.contentHtml = marked(data.content)
  data.sourceDomain = getDomain(data.sourceUrl)
  data.keywords.map((keyword) => keyword.trim())
  data.languages.map((language) => language.trim())
  data.platforms.map((platform) => platform.trim())
  data.projects.map((project) => project.trim())
}
'use strict'

const sanitize = require('./sanitize')

exports.before = {
  create: [
    sanitize.remove,
    sanitize.transform
  ],
  update: [
    sanitize.remove,
    sanitize.transform
  ],
  patch: [
    sanitize.remove,
    sanitize.transform
  ]
}

About services

The document In the section about Services contains this info

Adding query parameters, e.g. localhost:3030/messages?read=false will return this:

But the demo service doesn't provide any find method. So it will not return any result like:

[{
  "id": 1,
  "read": false,
  "text": "Feathers is great!",
  "createdAt": 1458490631911
}]

Create a guide for social sign-in

This guide might cover:

  • How to setup an app (maybe show Facebook or Google)
  • How to use OAuth2 with Feathers
  • How to cherry pick properties from a user's social profile
  • How to consolidate user's accounts

Document status codes

A documentation on feathers-rest status code conventions would be nice.

created: 201
noContent: 204
methodNotAllowed: 405

etc...

Feathers + Angular 2

Hi!

I'm trying to get up and running with the Feathers. I'm therefore trying out the Feathers + Angular 2 guide from the http://docs.feathersjs.com/guides/angular2.html. I have completed the Angular2 walkthrough, and I have gone through all the Feathers steps. But when I'm trying run it with npm start, I get the following error:

services/feathers.service.ts(1,18): error TS2304: Cannot find name 'require'.

The line it is referring to is this:

const feathers = require('feathers/client');

Under the Typescript section, from the guide, it states, You'll also need a module loader, a commonly used one is Webpack. If you've gone through the Angular 2 quickstart you should be good to go.

The Angular 2 quickstart used SystemJS, I have tried to figure out how to configure it to make it work, but with no luck.

Sorry for not figuring this out, but I coming from C# background, and I'm struggling a bit with all the different syntax variations of ES5 vs ES6 vs Typescript and transpiling...

Thanks in advance!

Write a guide on transitioning to microservices

What I mean by this is how you transition from your "monolithic" feathers app to a few smaller services. Again, using the context of that chat app will work great. We should be able to split it up into 3 services:

  • A user service
  • An auth service
  • A message service

We can show how they all talk to each other and possibly how you can now deploy this on Heroku or something.

Batching of emit events

Hi,

I'm writing an application that will do CRUD operations to a large number of records at a certain interval. I can't see in the documentation if there's any way to emit an event with multiple object changes at once instead of emitting the seperate events for each object1, object2, object3 on modification (I'm using redux so don't want to continually modify the state for each event as it will fire my heavy selectors often). Is this possible at all?

Proposal to get rid of file numbering.

I'd like to get rid of the file numbering. When you insert or remove a chapter, all of the links break for the entire book because you have renumbered the chapters. I think it would be smarter to use a word-based naming convention, so the chapter on providers would have the following files.

  • providers.md
  • providers.rest.md
  • providers.realtime.md
  • providers.realtime.socket-io.md
  • providers.realtime.primus.md
  • providers.create-your-own

We would use the SUMMARY.md (table of contents) file to know the ordering of the chapters.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.