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

docs: getting started #213

Closed
wants to merge 2 commits into from
Closed

Conversation

jakub-g
Copy link
Collaborator

@jakub-g jakub-g commented Jun 23, 2014

This also adds horizontal scrollbar to <code> if necessary

For review:

  • grunt,
  • goto localhost:8000/start

I largely used one of David's plunks and Paweł's repo https://github.com/PK1A/hsp-hello-gulp for code samples.

In the example I had to resort to klass and attributes so that I can really have a parameter in template that is actually passed further to the controller.

Paweł's sample is much simpler though the parameter passed in [1] is actually discarded and the init value has to be hardcoded in [2].

[1] https://github.com/PK1A/hsp-hello-gulp/blob/master/src/index.html#L8
[2] https://github.com/PK1A/hsp-hello-gulp/blob/master/src/hello.js#L2

@PK1A
Copy link
Contributor

PK1A commented Jun 23, 2014

@jakub-g just today I did some changes to the sample repo and gulp plugins so we might need to incorporate those changes in your PR. A couple of things have changed:

Ping me if you need more info on those changes.

# Getting started

To get started with Hashspace, you have two options: either compile the Hashspace files (`*.hsp`)
to JavaScript on the server side (during build time), or compile them dynamically in the browser
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Personally the option I prefer is to compile on file change, at development time, in a similar way to java compilation in Eclipse (this is what @PK1A hsp-hello-gulp is doing btw. - I don't think the pure server-side on the fly compilation is so useful (except for an online editor))
As such I would prefer the "design-time" compilation to be recommended, vs. server-side compilation..

jakub-g added a commit to jakub-g/hashspace that referenced this pull request Jun 25, 2014
This also adds horizontal scrollbar to `<code>` if necessary

Close ariatemplates#213
@jakub-g
Copy link
Collaborator Author

jakub-g commented Jun 25, 2014

Updated the PR. I moved the old page to a "getting started explained", and simplified the "getting started" page, reordered stuff, and wrote a simple gulp file ( still with two entries for compile/transpile but once a new version of gulp-hashspace is on npm, we can change it to have just entry there due to ariatemplates/gulp-hashspace@6a0936e )

Comments welcome.

jakub-g added a commit to jakub-g/hashspace that referenced this pull request Jun 27, 2014
This also adds horizontal scrollbar to `<code>` if necessary

Close ariatemplates#213
@jakub-g
Copy link
Collaborator Author

jakub-g commented Jun 27, 2014

Edit: added a plunk presenting the in-browser demo

This also adds horizontal scrollbar to `<code>` if necessary

Close ariatemplates#213
@jakub-g
Copy link
Collaborator Author

jakub-g commented Jun 30, 2014

Updated once again, to use noder 1.5.0 and <script type="application/x-noder"> instead of old <script type="noder">.

@coveralls
Copy link

Coverage Status

Coverage remained the same when pulling 7fb8e9a on jakub-g:getting-started into 729511f on ariatemplates:master.

@benouat
Copy link
Member

benouat commented Jun 30, 2014

@jakub-g
just a couple remarks :

  • Once on the page the menu is wrongly highlighted to API
  • I would link the in-browser intro disclaimer to the according paragraph

Apart from that, when fixed, you can merge ! 👍

@benouat
Copy link
Member

benouat commented Jun 30, 2014

Actually the few samples to demo how to launch a local webserver ❤️ ❤️
Especially the one from Python, so neat and so useful

@coveralls
Copy link

Coverage Status

Coverage remained the same when pulling ce57ca4 on jakub-g:getting-started into 729511f on ariatemplates:master.

@jakub-g jakub-g closed this in 15d17e6 Jun 30, 2014
@jakub-g jakub-g deleted the getting-started branch June 30, 2014 13:49
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

5 participants