Skip to content
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

Update README.md #233

Merged
merged 3 commits into from
Nov 23, 2023
Merged

Update README.md #233

merged 3 commits into from
Nov 23, 2023

Conversation

puneetbehl
Copy link
Contributor

Fixes #195

@puneetbehl
Copy link
Contributor Author

@matrei please take a look

@matrei
Copy link
Contributor

matrei commented Nov 16, 2023

@puneetbehl Now the download succeeds (although that url is quite a mouthful 😄) 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
Copy link
Contributor

matrei commented Nov 16, 2023

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

@matrei
Copy link
Contributor

matrei commented Nov 16, 2023

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
Copy link
Contributor

matrei commented Nov 16, 2023

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
Copy link
Contributor Author

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
Copy link
Contributor

matrei commented Nov 22, 2023

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.

@puneetbehl puneetbehl merged commit 2ba5b65 into 6.1.x Nov 23, 2023
6 checks passed
@puneetbehl puneetbehl deleted the puneetbehl-patch-1 branch December 14, 2023 12:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Installation instruction (in readme) does not work
2 participants