https://github.com/quasarframework/quasar-wrapper-feathersjs-api
[DEPRECATED] Quasar Framework Feathersjs API Wrapper
https://github.com/quasarframework/quasar-wrapper-feathersjs-api
Last synced: 9 months ago
JSON representation
[DEPRECATED] Quasar Framework Feathersjs API Wrapper
- Host: GitHub
- URL: https://github.com/quasarframework/quasar-wrapper-feathersjs-api
- Owner: quasarframework
- License: mit
- Archived: true
- Created: 2017-04-03T10:00:54.000Z (about 9 years ago)
- Default Branch: dev
- Last Pushed: 2017-10-11T15:05:37.000Z (over 8 years ago)
- Last Synced: 2024-03-01T13:38:57.607Z (about 2 years ago)
- Language: JavaScript
- Homepage:
- Size: 85.9 KB
- Stars: 28
- Watchers: 8
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Quasar Framework Feathers API Wrapper
> Build full web apps with Quasar/Feathers as a frontend/backend solution.
**This is a work in progress, not ready for production use and not yet part of the official Quasar framework**.
This wrapper comes into different "flavors" (corresponding to a branch) and although it is intended to be a standalone module it plays nice with some specific Quasar templates. To create your Quasar app starting from one of these templates run: `quasar init @claustres/quasar-templates#template-branch-name `, then jump into your app folder.
Here are the different "flavors":
* [Feathers chat demo app](https://github.com/quasarframework/quasar-wrapper-feathersjs-api/tree/dev) demonstrating authentication, services and real-time events, which plays nice with the template https://github.com/claustres/quasar-templates/tree/feathers-api.
* [Feathers Server-Side Rendering (SSR) demo app](https://github.com/quasarframework/quasar-wrapper-feathersjs-api/tree/ssr), which plays nice with the template https://github.com/claustres/quasar-templates/tree/feathers-api-ssr.
## Wrap your Quasar app
When integrated to Quasar from your root app dir you will have to run: `$ quasar wrap api feathers`
**While it is a work in progress, you can wrap it from your root app dir using**: `quasar init @quasarframework/quasar-wrapper-feathersjs-api#dev api`
Then from the backend wrapper folder called **api** install the server-side app dependencies: `$ npm install`
## Running for development
Make sure you keep running your frontend Quasar app (from root project folder): `$ quasar dev`
Then from the backend wrapper folder run the server-side app: `$ npm run dev`
## Building for production
Build your frontend Quasar app (from root project folder): `$ quasar build`.
Then from the backend wrapper folder build the server-side app: `$ npm run build`
## Running in production
From the backend wrapper folder run the server-side app: `$ npm run prod`
# What exactly provides this wrapper ?
> Mainly server-side code with babel integration to support ES2017.
The key points are the following:
- **src** directory host server-side code with a server entry point **main.js** that simply start a Feathers server
- **babel CLI** is used as a development dependency to transpile server-side code
- **dist** output directory is for transpiled backend files
- npm **clean** script cleans up transpiled code
- npm **dev** script runs the server in development mode on port 8081 by default (see **config** directory), client should be served as usual with Webpack
- npm **prod** script runs the server in production mode and serve client production version with Feathers
- **nodemon** is used as development dependency to watch changes in server side code and restart transpilation/server when required
- server-side **debug** mode in node is activated by default for development
- include a basic Feathers app **structure/setup** with models, services and hooks
- include a basic Feathers **datastore** based on a local NeDB
- include the Feathers **authentication** module
- include a basic **model** (a chat message) as an example
## License
Copyright (c) 2017 Luc Claustres
[MIT License](http://en.wikipedia.org/wiki/MIT_License)