-
Notifications
You must be signed in to change notification settings - Fork 39
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
Add README to scaffolded project #169
Changes from 1 commit
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,48 @@ | ||
## Getting Started | ||
|
||
Refer to the [Yesod Quickstart guide](https://www.yesodweb.com/page/quickstart) for install instructions. | ||
|
||
## Database Setup | ||
|
||
After installing Postgres, run: | ||
|
||
``` | ||
createuser PROJECTNAME_LOWER --password PROJECTNAME --superuser | ||
createdb PROJECTNAME_LOWER | ||
createdb PROJECTNAME_LOWER_test | ||
``` | ||
|
||
## Development | ||
|
||
Start a development server with: | ||
|
||
``` | ||
stack exec -- yesod devel | ||
``` | ||
|
||
As your code changes, your site will be automatically be recompiled and redeployed to localhost. | ||
|
||
## Tests | ||
|
||
``` | ||
stack test --flag PROJECTNAME_LOWER:library-only --flag PROJECTNAME_LOWER:dev | ||
``` | ||
|
||
(Because `yesod devel` passes the `library-only` and `dev` flags, matching those flags means you don't need to recompile between tests and development, and it disables optimization to speed up your tests). | ||
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. @snoyberg Is there a way Stack can default 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. Unfortunately not. A somewhat funny approach we could consider is adding a 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. Hm ok, something to consider then |
||
|
||
## Documentation | ||
|
||
* Read the [Yesod Book](https://www.yesodweb.com/book) online for free | ||
* Check [Stackage](http://stackage.org/) for documentation on the packages in your LTS Haskell version, or [search it using Hoogle](https://www.stackage.org/lts-9.14/hoogle?q=) | ||
* For local documentation, use: | ||
* `stack haddock --open` to generate Haddock documentation for your dependencies, and open that documentation in a browser | ||
* `stack hoogle <function, module or type signature>` to generate a Hoogle database and search for your query | ||
* The [Yesod cookbook](https://github.com/yesodweb/yesod-cookbook) has sample code for various needs | ||
|
||
## Getting Help | ||
|
||
* Ask questions on [Stack Overflow, using the Yesod or Haskell tags](https://stackoverflow.com/questions/tagged/yesod+haskell) | ||
* Ask the [Yesod Google Group](https://groups.google.com/forum/#!forum/yesodweb) | ||
* There are several chatrooms you can ask for help: | ||
* For IRC, try Freenode#yesod and Freenode#haskell | ||
* [Functional Programming Slack](https://fpchat-invite.herokuapp.com/), in the #haskell, #haskell-beginners, or #yesod channels. |
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.
Should probably command on needing to run
stack build yesod-bin
first.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.
So that's covered in the Quick Start guide, but I think it would be good to pull the stuff from the QuickStart guide into this README (the quickstart guide hasn't changed that much since the transition to Stack).
The Quickstart guide recommends this command:
Do you know offhand if
cabal-install
is actually necessary?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.
cabal-install
is no longer necessary, we can remove that recommendation.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.
Nice, saw you removed it from the quickstart guide as well 👍