-
-
Notifications
You must be signed in to change notification settings - Fork 1.1k
Add quasar framework docs for generator. #836
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,80 @@ | ||
# Quasar Framework Generator | ||
|
||
Create a Quasar Framework application using | ||
[quasar-cli](https://quasar.dev/quasar-cli/installation): | ||
|
||
$ quasar create my-app | ||
$ cd my-app | ||
|
||
$ yarn global add @api-platform/client-generator | ||
|
||
In the app directory, generate the files for the resource you want: | ||
|
||
$ generate-api-platform-client -g quasar https://demo.api-platform.com src/ --resource foo | ||
# Replace the URL by the entrypoint of your Hydra-enabled API | ||
# Omit the resource flag to generate files for all resource types exposed by the API | ||
|
||
The code is ready to be executed! Register the generated routes in `src/router/routes.js` | ||
|
||
```javascript | ||
import fooRoutes from '../generated/router/foo'; | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. In a next version of the generator, you could use There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Thx, I'll keep in mind. |
||
|
||
const routes = [ | ||
{ | ||
path: '/', | ||
component: () => import('layouts/MyLayout.vue'), | ||
children: [ | ||
...fooRoutes | ||
], | ||
|
||
``` | ||
|
||
and store modules in the `src/store/index.js` file. | ||
|
||
```javascript | ||
// Replace "foo" with the name of the resource type | ||
import foo from '../generated/store/modules/foo/'; | ||
|
||
export default function(/* { ssrContext } */) { | ||
const Store = new Vuex.Store({ | ||
modules: { | ||
foo, | ||
}, | ||
|
||
``` | ||
|
||
Make sure to update the `quasar.conf.js` file with the following: | ||
|
||
```javascript | ||
framework: { | ||
components: [ | ||
'QTable', | ||
'QTh', | ||
'QTr', | ||
'QTd', | ||
'QAjaxBar', | ||
'QBreadcrumbs', | ||
'QBreadcrumbsEl', | ||
'QSpace', | ||
'QInput', | ||
'QForm', | ||
'QSelect', | ||
'QMarkupTable', | ||
'QDate', | ||
'QTime', | ||
'QCheckbox', | ||
'QPopupProxy' | ||
|
||
... | ||
], | ||
directives: [..., 'ClosePopup'], | ||
plugins: ['Notify'], | ||
config: { | ||
... | ||
notify: { | ||
position: 'top', | ||
multiLine: true, | ||
timeout: 0, | ||
}, | ||
}, | ||
``` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Could simply be
yarn dlx @api-platform/client-generator -g quasar https://demo.api-platform.com src/ --resource foo
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Of course, could be nice, but I've tried to keep the same format as in Vue generator. I can modify both if you want.
Also, there are NPM users.