Skip to content

Commit

Permalink
#18 documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Dufgui committed Feb 24, 2018
1 parent 5f8b765 commit 30b5737
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 8 deletions.
21 changes: 15 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,8 @@ As this is a [JHipster](http://jhipster.github.io/) module, we expect you have J

# Compatibility

Now it's works for angularjs and angular 4.
Before 2.0.2 (included) it's angular 4.
After 2.0.4 (included) it's angular 5.
I haven't tested with micro service or any not-sql based project (cassandra, mongodb, elasticsearch, ...).

# Installation
Expand Down Expand Up @@ -100,17 +101,25 @@ The following types are supported:
- js read service
- java get web service
- get returned object

## I have generated, so what's next

you generate page but you see empty page and you have errors in ts. For some page type it's normal.
The goal of this module, is just to save time by generating "plumbing" files.

### Example
If you choose "Load and Save data to server" :
- It create empty java web service and visual object.
- You can see a new entry in your navbar wich target an empty html page.
- You have js/ts controller is there but don't call the js/ts service to load or save data.
- It's now you turn to code...


## Road Map

Here is the list of types to do

- **Workflow** generate
- multiple step html pages (form) with link to previous and next steps
- multiple step js controllers
- js service with init get and final write method
- java web service with get and post
- reactjs client side


# License
Expand Down
4 changes: 2 additions & 2 deletions generators/app/prompts.js
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ function askForPageSetConfig() {
when: response => response.pageSet === '_CreateNew_',
type: 'input',
name: 'pageSetGlyphIcon',
message: 'Enter the page glyphicon name (see https://getbootstrap.com/components/):',
message: 'Enter the optional page set icon name in font awesome for angular or glyphicon for angularjs ( (upload for example):',
}
];

Expand Down Expand Up @@ -184,7 +184,7 @@ function askForPageConfig() {
when: !this.regenerate,
type: 'input',
name: 'pageGlyphIcon',
message: 'Enter the page glyphicon name (see https://getbootstrap.com/components/):',
message: 'Enter the optional page icon name in font awesome for angular or glyphicon for angularjs (cloud-upload-alt for example):',
},
{
when: this.regenerate,
Expand Down

0 comments on commit 30b5737

Please sign in to comment.