Skip to content

Commit

Permalink
Reorganizing framework guides into their own section
Browse files Browse the repository at this point in the history
  • Loading branch information
daffl committed Apr 13, 2016
1 parent dce6503 commit 2877065
Show file tree
Hide file tree
Showing 16 changed files with 34 additions and 31 deletions.
19 changes: 10 additions & 9 deletions SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,16 @@
* [REST](clients/vanilla-rest.md)
* [Socket.io](clients/vanilla-socket-io.md)
* [Primus](clients/vanilla-primus.md)
* [Frameworks](frameworks/readme.md)
* [React](frameworks/react.md)
* [React Native](frameworks/react-native.md)
* [jQuery](frameworks/jquery.md)
* [CanJS](frameworks/canjs.md)
* [Angular](frameworks/angular.md)
* [Angular 2](frameworks/angular2.md)
* [Vue.js](frameworks/vuejs.md)
* [iOS](frameworks/ios.md)
* [Android](frameworks/android.md)
* [Middleware](middleware/readme.md)
* [Express Middleware](middleware/express.md)
* [Routing and Versioning](middleware/routing.md)
Expand All @@ -74,15 +84,6 @@
* [Migrating to Feathers 2](guides/migrating.md)
* [Using A View Engine](guides/using-a-view-engine.md)
* [Creating a plugin](guides/creating-a-plugin.md)
* [React](guides/react.md)
* [React Native](guides/react-native.md)
* [jQuery](guides/jquery.md)
* [CanJS](guides/canjs.md)
* [Angular](guides/angular.md)
* [Angular 2](guides/angular2.md)
* [Vue.js](guides/vuejs.md)
* [iOS](guides/ios.md)
* [Android](guides/android.md)
* [Help](help/readme.md)
* [FAQ](help/faq.md)
* [Contributing](contributing.md)
Expand Down
7 changes: 1 addition & 6 deletions clients/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,12 +16,7 @@ In order to communicate with a Feathers API you don't need to use Feathers as th

Because it is easy to integrate, Feathers does not currently have any official framework specific bindings. Work on [iOS](https://github.com/feathersjs/feathers-ios) and [Android](https://github.com/feathersjs/feathers-android) SDKs are in progress.

To give you a better idea of how the Feathers client plays with other frameworks we've written some guides:

- [jQuery](../guides/jquery.md)
- [React](../guides/react.md)

We are adding new [guides](../guides/readme.md) for new frameworks all the time! If you are having any trouble with your framework of choice, [create an issue](https://github.com/feathersjs/feathers/issues/new) and we'll try our best to help out.
To give you a better idea of how the Feathers client plays with other frameworks we've written some guides in the [frameworks chapter](../frameworks/readme.md). We are adding new ones all the time! If you are having any trouble with your framework of choice, [create an issue](https://github.com/feathersjs/feathers/issues/new) and we'll try our best to help out.

### Caveats

Expand Down
4 changes: 2 additions & 2 deletions guides/android.md → frameworks/android.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Feathers + Android

We haven't had time to publish this guide yet. If you feel like you could contribute one feel free to [open a pull request](https://github.com/feathersjs/feathers-docs/edit/master/guides/android.md).
We haven't had time to publish this guide yet. If you feel like you could contribute one feel free to [open a pull request](https://github.com/feathersjs/feathers-docs/edit/master/frameworks/android.md).

An official Feathers client does not exist yet. We have set up a placeholder for it so if you feel like contributing head over to the [feathers-android repo](https://github.com/feathersjs/feathers-android).
An official Feathers client does not exist yet. We have set up a placeholder for it so if you feel like contributing head over to the [feathers-android repo](https://github.com/feathersjs/feathers-android).
2 changes: 1 addition & 1 deletion guides/angular.md → frameworks/angular.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# Feathers + Angular

We haven't had time to publish this guide yet. If you feel like you could contribute one feel free to [open a pull request](https://github.com/feathersjs/feathers-docs/edit/master/guides/angular.md).
We haven't had time to publish this guide yet. If you feel like you could contribute one feel free to [open a pull request](https://github.com/feathersjs/feathers-docs/edit/master/frameworks/angular.md).
File renamed without changes.
2 changes: 1 addition & 1 deletion guides/canjs.md → frameworks/canjs.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# Feathers + CanJS

We haven't had time to publish this guide yet. If you feel like you could contribute one feel free to [open a pull request](https://github.com/feathersjs/feathers-docs/edit/master/guides/canjs.md).
We haven't had time to publish this guide yet. If you feel like you could contribute one feel free to [open a pull request](https://github.com/feathersjs/feathers-docs/edit/master/frameworks/canjs.md).
4 changes: 2 additions & 2 deletions guides/ios.md → frameworks/ios.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Feathers + iOS

We haven't had time to publish this guide yet. If you feel like you could contribute one feel free to [open a pull request](https://github.com/feathersjs/feathers-docs/edit/master/guides/ios.md).
We haven't had time to publish this guide yet. If you feel like you could contribute one feel free to [open a pull request](https://github.com/feathersjs/feathers-docs/edit/master/frameworks/ios.md).

There is an official iOS Feathers client in progress. If you feel like helping out head over to the [feathers-ios repo](https://github.com/feathersjs/feathers-ios).
There is an official iOS Feathers client in progress. If you feel like helping out head over to the [feathers-ios repo](https://github.com/feathersjs/feathers-ios).
File renamed without changes.
4 changes: 2 additions & 2 deletions guides/react-native.md → frameworks/react-native.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Feathers + React Native

We haven't had time to publish this guide yet. If you feel like you could contribute one feel free to [open a pull request](https://github.com/feathersjs/feathers-docs/edit/master/guides/react-native.md).
We haven't had time to publish this guide yet. If you feel like you could contribute one feel free to [open a pull request](https://github.com/feathersjs/feathers-docs/edit/master/frameworks/react-native.md).

We do however, have a working [React Native Chat App](https://github.com/feathersjs/feathers-react-native-chat) that you can peruse in the mean time.
We do however, have a working [React Native Chat App](https://github.com/feathersjs/feathers-react-native-chat) that you can peruse in the mean time.
File renamed without changes.
7 changes: 7 additions & 0 deletions frameworks/readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Frameworks

Because it is easy to integrate [on the client](../clients/readme.md), Feathers currently does not have any official framework specific bindings and [iOs](./ios.md) and [Android](./android.md) clients are in the works.

In this chapter we will show some guides how to integrate Feathers with other JavaScript frameworks. We are adding new ones all the time! If you are having any trouble with your framework of choice, [create an issue](https://github.com/feathersjs/feathers/issues/new) and we'll try our best to help out.

All guides will show how to create a frontend for the API built in the [Your First App](../getting-started/readme.md) section. If you haven't done so you'll want to go through that tutorial or you can find a [working example here](https://github.com/feathersjs/feathers-chat).
2 changes: 1 addition & 1 deletion guides/vuejs.md → frameworks/vuejs.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# Feathers + Vue.js

We haven't had time to publish this guide yet. If you feel like you could contribute one feel free to [open a pull request](https://github.com/feathersjs/feathers-docs/edit/master/guides/vuejs.md).
We haven't had time to publish this guide yet. If you feel like you could contribute one feel free to [open a pull request](https://github.com/feathersjs/feathers-docs/edit/master/frameworks/vuejs.md).
2 changes: 1 addition & 1 deletion getting-started/formatting-and-hooks.md
Original file line number Diff line number Diff line change
Expand Up @@ -183,4 +183,4 @@ module.exports = function(options) {

That's it! We now have a fully-functional, real-time chat API complete with user signup, local authentication, and authorization. You've now had an introduction to [services](../services/readme.md), [hooks](../hooks/readme.md) and [middleware](../middleware/readme.md), which is almost everything there is to Feathers.

In the next chapter we will briefly talk about [building a frontend](frontend.md) for our Chat app before learning more about Feathers and diving into the [guides](../guides/readme.md).
In the next chapter we will briefly talk about [building a frontend](frontend.md) for our Chat app before learning more about Feathers and diving into the [specific framework guides](../frameworks/readme.md).
8 changes: 4 additions & 4 deletions getting-started/frontend.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@

So far in this chapter we created a REST and real-time API to send messages including authentication and user management. We also added a static login and signup HTML page. Now it is time to use that API in a frontend. Feathers works great with any client that can connect through HTTP(S) or websockets to a REST API. For more details on what commands to send and listen to, follow up in the [client use chapter](../clients/readme.md). Sometimes it is just a few lines of code to make an existing front-end turn real-time.

Feathers is also universally usable and provides a [JavaScript client](../clients/feathers.md) that works in the Browser, React Native and other NodeJS servers. This makes it very easy to integrate with most JavaScript libraries and client side frameworks. In the [guides section](../guides/readme.md) we've put together a growing list of integration guides to build real-time front-ends for the chat API we created in this chapter:
Feathers is also universally usable and provides a [JavaScript client](../clients/feathers.md) that works in the Browser, React Native and other NodeJS servers. This makes it very easy to integrate with most JavaScript libraries and client side frameworks. In the [frameworks section](../frameworks/readme.md) we've put together a growing list of integration guides to build real-time front-ends for the chat API we created in this chapter:

- [jQuery Feathers Chat](../guides/jquery.md)
- [React Feathers Chat](../guides/react.md)
- [Feathers and Angular 2](../guides/angular2.md)
- [jQuery Feathers Chat](../frameworks/jquery.md)
- [React Feathers Chat](../frameworks/react.md)
- [Feathers and Angular 2](../frameworks/angular2.md)

If you don't see your favourite framework, do not despair! We have more information on how to use a Feathers API on the client in the [Client Use chapter](../clients/readme.md) and we're always open for [suggestions and questions](../help/readme.md). If you think you can help write a guide, we'd love to hear from you!
2 changes: 1 addition & 1 deletion guides/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@

This is where we will have guides for common situations. We will be adding to this section over time but if you have done something cool with Feathers that we don't already have a guide for feel free to [open a pull request](https://github.com/feathersjs/feathers-docs/edit/master/guides/readme.md).

Naturally, our first guide is [how you can migrate to your existing app to Feathers 2](./migrating.md).
Naturally, our first guide is [how you can migrate to your existing app to Feathers 2](./migrating.md).
2 changes: 1 addition & 1 deletion why/vs/meteor.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Feathers is community supported, whereas Meteor is venture backed and has raised

Meteor only has official support for MongoDB but there are some community modules of various levels of quality that support other databases. Meteor has it's own package manager and package ecosystem. They have their own template engine called Blaze which is based off of Mustache along with their own build system, but also have guides for Angular and React.

Feathers has official support for [many more databases](../../databases/readme.md) and supports any front-end framework or view engine that you want. We have [guides](../../guides/readme.md) for integrating Feathers with many of the most popular.
Feathers has official support for [many more databases](../../databases/readme.md) and supports any front-end framework or view engine that you want. We have [framework guides](../../frameworks/readme.md) for integrating Feathers with many of the most popular.

Feathers uses the defacto JavaScript package manager [npm](http://npmjs.org). As a result you can utilize the hundreds of thousands of modules published to npm. Feathers lets you decide whether you want to use Gulp, Grunt, Browserify, Webpack or any other build tool.

Expand Down

0 comments on commit 2877065

Please sign in to comment.