search

elmbridge / curriculum

Curriculum for Elmbridge
https://elmbridge.github.io/curriculum/
66 stars 14 forks source link

The Elm Architecture: downloading the skeleton app -> git clone or encourage to git init? #58

Open ento opened 8 years ago

ento commented 8 years ago

It'd be a good thing to guide the reader to set up a safe environment to experiment in.

git clone -b hello-world https://github.com/elmbridge/elmoji-translator.git can clone and checkout a specific ref in one command. (add --single-branch to trim down on the size of the download)

ento commented 8 years ago

Hmm, elm-make complains if I switch to a different release tag that requires a new package. Maybe one reason to start with a new download or a clone each time. (or is it an elm-make bug?)

$ rm -rf elm-stuff
$ git co hello-world
Previous HEAD position was 93f955f... Release 0 (Boilerplate)
HEAD is now at a1dcfd8... style with materialize.css and custom styles
$ PATH=../elmbridge-curriculum/node_modules/.bin:$PATH ../elmbridge-curriculum/node_modules/.bin/elm-make Main.elm --output=dist/main.js
Some new packages are needed. Here is the upgrade plan.

  Install:
    elm-lang/core 4.0.5
    elm-lang/html 1.1.0
    elm-lang/virtual-dom 1.1.1

Do you approve of this plan? [Y/n]
Starting downloads...

  ● elm-lang/virtual-dom 1.1.1
  ● elm-lang/html 1.1.0
  ● elm-lang/core
 4.0.5
Packages configured successfully!
Success! Compiled 34 modules.
Successfully generated dist/main.js
tomatl:elmoji-translator ento$ git co release-0
Previous HEAD position was a1dcfd8... style with materialize.css and custom styles
HEAD is now at 93f955f... Release 0 (Boilerplate)
$ PATH=../elmbridge-curriculum/node_modules/.bin:$PATH ../elmbridge-curriculum/node_modules/.bin/elm-make Main.elm --output=dist/main.js
Could not find package elm-community/list-extra.

Maybe your elm-stuff/ directory has been corrupted? You can usually fix stuff
like this by deleting elm-stuff/ and rebuilding your project.
raorao commented 8 years ago

I'd like to resolve this alongside https://github.com/elmbridge/curriculum/issues/36, as any offline usage instructions will also have to explain git tags. Not sure the best way to do this without getting too far into the weeds.

For now, tagging as an enhancement.

siruguri commented 8 years ago

From a student's point of view, simply saying "run git this way" should suffice... o/w someone who doesn't understand tar/gz will have trouble with those tarballs. I have a feeling git has more mindshare than tar -zxvf.

Would just having one "for students" branch in the repo, that elmbridges work off of, be a good solution?

raorao commented 7 years ago

I have a feeling git has more mindshare than tar -zxvf.

I also believe that to be the case, but I also believe that GUI tools for unzipping are more accessible than either git or tar.

a git-based feels more in-line with our sensibilities as developers, but given it's issues with elm-make, I don't think it would necessarily be more responsible for us to suggest.

siruguri commented 7 years ago

I'll keep the elm-make issues in mind ... maybe I'll propose a bonus section later. I'd say this can be closed for now.