Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gfontenot/atxfccutcrew
https://github.com/gfontenot/atxfccutcrew
Last synced: 23 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/gfontenot/atxfccutcrew
- Owner: gfontenot
- Created: 2023-09-10T15:18:04.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-06-11T21:20:13.000Z (5 months ago)
- Last Synced: 2024-06-12T05:40:16.921Z (5 months ago)
- Language: Haskell
- Size: 168 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## Database Setup
After installing Postgres, run:
```
createuser atxfccutcrew --pwprompt --superuser
# Enter password atxfccutcrew when prompted
createdb atxfccutcrew
createdb atxfccutcrew_test
```
## Haskell Setup
1. If you haven't already, [install Stack](https://haskell-lang.org/get-started)
* On POSIX systems, this is usually `curl -sSL https://get.haskellstack.org/ | sh`
2. Install the `yesod` command line tool: `stack install yesod-bin --install-ghc`
3. Build libraries: `stack build`
If you have trouble, refer to the [Yesod Quickstart guide](https://www.yesodweb.com/page/quickstart) for additional detail.
## Development
Start a development server with:
```
stack exec -- yesod devel
```
As your code changes, your site will be automatically recompiled and redeployed to localhost.
## Tests
```
stack test --flag atxfccutcrew:library-only --flag atxfccutcrew: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 test compile times).
## 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/hoogle?q=). Tip: Your LTS version is in your `stack.yaml` file.
* For local documentation, use:
* `stack haddock --open` to generate Haddock documentation for your dependencies, and open that documentation in a browser
* `stack hoogle ` 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.