Skip to content

Commit 5b9f7bf

Browse files
committed
Add example-applications page.
1 parent e4ce28c commit 5b9f7bf

File tree

2 files changed

+48
-0
lines changed

2 files changed

+48
-0
lines changed

docs/.vuepress/config.js

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,8 @@ module.exports = {
1010
sidebar: [
1111
'/api-overview.md',
1212
'/3.0-major-release.md',
13+
'/getting-started.md',
14+
'/example-applications.md',
1315
'/vue-plugin.md',
1416
'/service-plugin.md',
1517
'/auth-plugin.md',

docs/example-applications.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
---
2+
title: Example Applications
3+
sidebarDepth: 3
4+
---
5+
6+
# Example Applications
7+
8+
On this page you will find any example applications using Feathers-Vuex that have been shared by the community. If there's something you would like to see here, feel free to make a PR to add it to the [Community Examples list](#community-examples).
9+
10+
## Feathers Chat
11+
12+
The [Feathers Chat Example for Feathers Vuex](https://github.com/feathersjs-community/feathers-chat-vuex) has been updated to `[email protected]` and everything has been rewritten with the Vue composition API. The old repo is now available at [https://github.com/feathersjs-ecosystem/feathers-chat-vuex-0.7](https://github.com/feathersjs-ecosystem/feathers-chat-vuex-0.7). The following information will assist you in seeing the "before" and "after" of the refactor to [email protected].
13+
14+
![Feathers Chat](https://camo.githubusercontent.com/14b6b2d6dd2475c3b83eb1ade6aedbcd8cf94139/68747470733a2f2f646f63732e66656174686572736a732e636f6d2f6173736574732f696d672f66656174686572732d636861742e39313936303738352e706e67)
15+
16+
### Before and After Comparisons
17+
18+
- The folder structure is similar, since this is a VueCLI application. Some of the components in the old version have been moved into the `views` folder.
19+
- `/components/Home.vue` is now `/views/Home.vue`
20+
- `/components/Signup.vue` is now `/views/Signup.vue`
21+
- `/components/Login.vue` is now `/views/Login.vue`
22+
- `/components/Chat/Chat.vue` is now `/views/Chat.vue`
23+
- The `/components` folder has been flattened. There are no more subfolders.
24+
- Component refactors:
25+
- [Login.vue](https://github.com/feathersjs-ecosystem/feathers-chat-vuex/commit/eb9ba377c5705c1378bee72661a13dd0db48be05)
26+
- [Signup.vue](https://github.com/feathersjs-ecosystem/feathers-chat-vuex/commit/478710ed84869d33a9286078496c1e5974a95067)
27+
- [Users.vue](https://github.com/feathersjs-ecosystem/feathers-chat-vuex/commit/02b47149c80c27cdeb611c2f4438b4c62159c644)
28+
- [Messages.vue](https://github.com/feathersjs-ecosystem/feathers-chat-vuex/commit/930743c1679cc4ed9d691532a7dff1d6a34398e6)
29+
- [Compuser.vue](https://github.com/feathersjs-ecosystem/feathers-chat-vuex/commit/cd5c8898ede270d5e22f9c6ef1450d3f3c6278c9)
30+
- [Chat.vue](https://github.com/feathersjs-ecosystem/feathers-chat-vuex/commit/39eb3e13f6921b0d0524ae4ac7942b9ce78b222c)
31+
- [Messages.vue](https://github.com/feathersjs-ecosystem/feathers-chat-vuex/commit/e5cf7fb0cc8eab80ee3dc441afafb1399d69059e)
32+
33+
### More to Come
34+
35+
The Feathers Chat example is a pretty simple application. Its primary purpose is to show off how easy it is to do realtime with FeathersJS. (FeathersJS continues to be the only framework that treats real-time communication as a first-class citizen with the same API across multiple transports.) But it doesn't properly showcase all of the great features in Feathers-Vuex 3.0. This requires a solution that:
36+
37+
1. Still allows comparison of Feathers Chat applications made with other frameworks.
38+
2. Allows the version of Feathers Chat built with Feathers-Vuex to add features and showcase things you might actually use in production.
39+
40+
If there are features which you would like to see implemented, please open an issue in the [feathers-chat-vuex Repo](https://github.com/feathersjs-community/feathers-chat-vuex) for your idea to be considered.
41+
42+
## Community Examples
43+
44+
If you have created or know of an example application, please add it, here.
45+
46+
- [Feathers-Chat-Vuex](https://github.com/feathersjs-community/feathers-chat-vuex)

0 commit comments

Comments
 (0)