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

Mention Spin to create new projects #42

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

tmattio
Copy link
Contributor

@tmattio tmattio commented Apr 21, 2021

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.

@aantron
Copy link
Owner

aantron commented Apr 21, 2021

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 aantron force-pushed the master branch 2 times, most recently from 5880b21 to a63867d Compare April 21, 2021 17:06
@aantron
Copy link
Owner

aantron commented Apr 21, 2021

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

@tmattio tmattio marked this pull request as ready for review June 28, 2021 11:10
@tmattio
Copy link
Contributor Author

tmattio commented Jun 28, 2021

@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 🙂

@aantron
Copy link
Owner

aantron commented Jun 29, 2021

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

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

Successfully merging this pull request may close these issues.

None yet

2 participants