dream icon indicating copy to clipboard operation
dream copied to clipboard

Mention Spin to create new projects

Open tmattio opened this issue 4 years ago • 4 comments

This PR recommends Spin to create new Dream projects in the Quickstart section.

I've put the mention of Spin higher than the quickstart script, but of course, I'm happy to change that if you feel the middleware example is a better entry point for new users.

I'm creating the PR as draft as there are a few things I'd like to add to the template before it is recommended. Namely, making the setup of TailwindCSS and Turbolink optional, and adding some boilerplate examples with Caqti.

tmattio avatar Apr 21 '21 14:04 tmattio

I would indeed move it lower, after the script but before opam, because Dream has a sort of "opt-in" design, where you start with the minimal and know exactly what you're adding every step of the way.

However, a hypothetical higher-level framework based on Dream might do it the other way. But that higher-level framework might be just a good template :)

aantron avatar Apr 21 '21 16:04 aantron

If it helps to make it more visible, maybe it can get a section heading. Like "### Starter project" or "### Project template"

aantron avatar Apr 21 '21 17:04 aantron

@aantron I improved the Spin template substantially (all of the features are now optional), and the latest Spin release comes with an Opam plugin, so with Opam installed, users can run:

opam spin new https://github.com/ocaml-templates/spin-dream.git

I'm happy with the state of the workflow, so this is ready to review if you want 🙂

tmattio avatar Jun 28 '21 11:06 tmattio

Thanks! I opened several issues and PRs in the spin-dream repo.

aantron avatar Jun 29 '21 10:06 aantron