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

Provide a template #1065

Closed
sir4ur0n opened this issue Oct 31, 2018 · 4 comments
Closed

Provide a template #1065

sir4ur0n opened this issue Oct 31, 2018 · 4 comments

Comments

@sir4ur0n
Copy link

Now that commercialhaskell/stack#4039 is released in Stack 1.9.1, it would be nice to provide Stack templates in this repo.
Maybe start again from https://github.com/commercialhaskell/stack-templates/blob/master/servant.hsfiles and fix it (I think it's broken and not up-to-date)?

Proposals:

  • A template with a single, minimalistic API. This could contain more or less the result of the A first example section of the tutorial.
  • A production-grade template with several APIs showing the full potential of Servant, including code organization (import API types and handlers from several modules), API Swagger documentation, etc. Maybe even some tests? I'm not sure about this part. Basically, something that I can create using stack new foobar github:haskell-servant/servant-on-steroids, build, exec, and just see what can be built/done with Servant in a fraction of minute. Then the curious can start toying with the code, the others will read carefully the documentation. Each its own pace/learning style.
@alpmestan
Copy link
Contributor

I certainly wouldn't mind shipping templates in the repo, if that makes the life of stack users (especially beginners) easier. I agree that it would be nice to have a very simple one, and then possibly incrementally fancier ones that set up clients, tests, logging, auth, etc. Are you volunteering to add this @sir4ur0n? :-)

@sir4ur0n
Copy link
Author

sir4ur0n commented Nov 1, 2018

I don't mind proposing the simple template (I definitely don't know enough Servant fu for the complete one). However I'm waiting for commercialhaskell/stack#4344 to befixed first 😞

@alpmestan
Copy link
Contributor

OK, feel free to use this issue to track anything related to servant stack templates.

@sir4ur0n
Copy link
Author

sir4ur0n commented Apr 3, 2019

No sooner than 5 months later, here it is 😄 Sorry I had completely forgotten about it, then yesterday a coworker struggled with Servant (because he used the old template) and I remembered ^^'

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

No branches or pull requests

2 participants