Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/j-maas/route-redundant-pattern-reproduction
https://github.com/j-maas/route-redundant-pattern-reproduction
Last synced: 11 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/j-maas/route-redundant-pattern-reproduction
- Owner: j-maas
- Created: 2022-12-30T11:13:07.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2023-04-22T14:42:05.000Z (over 1 year ago)
- Last Synced: 2024-10-27T13:13:33.495Z (about 2 months ago)
- Language: Elm
- Size: 313 KB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# README
This is a starter to try the elm-pages 3.0 alpha. Any feedback would be very helpful for getting the release ready to go!
You can try this out on Netlify in just a couple of clicks with this button:
[![Deploy to Netlify](https://www.netlify.com/img/deploy/button.svg)](https://app.netlify.com/start/deploy?repository=https://github.com/dillonkearns/elm-pages-3-alpha-starter)
## Setup Instructions
You can clone this repo with `git clone https://github.com/dillonkearns/elm-pages-3-alpha-starter.git`.
`npm install` from the cloned repo. Before running the dev server or build, make sure to install Lamdera (see below).
### Install Lamdera
[Install Lamdera with these instructions](https://dashboard.lamdera.app/docs/download).
`elm-pages` 3.0 uses the lamdera compiler, which is a superset of the Elm compiler with some extra functionality to automatically serialize Elm types to Bytes. That means there is no more `OptimizedDecoder` API, you can just use regular `elm/json` Decoders! And no more `DataSource.distill`, since types are now automatically serialized all those optimizations come for free.
### Debugging Lamdera Errors
Sometimes Lamdera will give compiler errors due to corrupted dependency cache. These messages will display a note at the bottom:
```
-- PROBLEM BUILDING DEPENDENCIES ---------------...
Note: Sometimes `lamdera reset` can fix this problem by rebuilding caches, so
give that a try first.
```Be sure to use `lamdera reset` to reset the caches for these cases. See more info about that in the Lamdera docs: https://dashboard.lamdera.app/docs/ides-and-tooling#problem-corrupt-caches
### Docs
Check out [the 3.0 Package Docs](https://package.elm-lang.org/packages/dillonkearns/elm-pages-v3-beta/latest/). The 3.0 docs are still a work in progress. As part of the final release, I will be going through and filling in documentation and updating missing docs. Feel free to make a pull request to update or add docs, or share feedback on the APIs and naming.
You can also use `npx elm-pages docs` from your project to view the documentation for the `RouteBuilder` module.
## Running `elm-pages codegen` command
- `npm install`
- `npx elm-pages codegen Cli User.Id_` - now you can try out the generator! And you can tweak it, or even define new generator modules in the `codegen/` folder!