search

grails / grails-forge

This is Grails project creator. Grails projects may be created using the browser interface, Command Line, or via CURL.
Apache License 2.0
3 stars 9 forks source link

Update README.md #233

Closed puneetbehl closed 11 months ago

puneetbehl commented 11 months ago

Fixes #195

puneetbehl commented 11 months ago

@matrei please take a look

matrei commented 11 months ago

@puneetbehl Now the download succeeds (although that url is quite a mouthful :smile:) and the application starts. Maybe drop the --request parameter as GET is default and then use shortform for --location (-L) and --output (-o) to at least shorten it a bit?

matrei commented 11 months ago

Also the above says "If you prefer not to install an application to create Micronaut applications..."

matrei commented 11 months ago

Some more comments on the readme 😄

The swagger UI at https://grailsforge-latest-cjmq3uyfcq-uc.a.run.app/swagger/views/swagger-ui/index.html (link in the response from):

curl https://grailsforge-latest-cjmq3uyfcq-uc.a.run.app

breaks with JS error: Uncaught ReferenceError: SwaggerUIBundle is not defined.

Also in the http response from that URL it shows how to create an app:

To create a default application:

    $ curl https://grailsforge-latest-cjmq3uyfcq-uc.a.run.app/create/WEB/example -o example.zip

which is without the --location (-L) curl parameter. Then I wonder - is the -L necessary in the Readme example? If it is, it should also be added to the http response. Otherwise it should be removed from the Readme.

None of the links under the API and Documentation headings are working as they should.

Maybe the snapshots link should point to https://s01.oss.sonatype.org/content/repositories/snapshots/org/grails/forge/ instead of at the root?

There is no section #usingsnapshots in the Grails documentation:

See the documentation in the Grails Docs for how to configure your build to use snapshots.

matrei commented 11 months ago

Also the app type is missing from the curl example in the readme, which now returns:

{"message":"Not Found","_links":{"self":{"href":"/create/test1.zip","templated":false}},"_embedded":{"errors":[{"message":"Page Not Found"}]}}
puneetbehl commented 11 months ago

Thank you for your feedback, I have applied your suggestions. However, the swagger-ui and rapidoc views are not working on latest because unfortunately those aren't enable in the latest. This will be fixed with the next release.

Also, can you please point me to the example CURL which is not working because the following CURL request is also fine:

curl https://grailsforge-latest-cjmq3uyfcq-uc.a.run.app/demo.zip -o demo.zip
matrei commented 11 months ago

Great!

I tried again tonight using your curl example and now I do get a proper starter zip. 👍 I must have mistakenly had a /create without the /{appType} in the path: curl https://grailsforge-latest-cjmq3uyfcq-uc.a.run.app/create/demo.zip -o demo.zip which returns the response I showed earlier.