https://github.com/sukima/spine.app.sample

An example of how to use spine out-of-the-box with the latest not yet released edge code
https://github.com/sukima/spine.app.sample

Last synced: 17 days ago
JSON representation

An example of how to use spine out-of-the-box with the latest not yet released edge code

• Host: GitHub
• URL: https://github.com/sukima/spine.app.sample
• Owner: sukima
• Created: 2012-10-08T22:51:50.000Z (about 12 years ago)
• Default Branch: master
• Last Pushed: 2012-10-08T22:52:24.000Z (about 12 years ago)
• Last Synced: 2024-10-21T20:59:11.181Z (30 days ago)
• Language: JavaScript
• Size: 109 KB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
Getting a spine app running out-of-the-box

==========================================

Date: October 08, 2012

[Spine][spine] is a fantastic MVC framework that I started working with. Mainly

because I wanted a clear distinction between Model/View/Controller code and I

wanted to write in [coffee-script][] along with documentation in coffee-script.

I also really liked the ease of creating, building, and developing that [hem][]

and the [Spine.app][spine-app] suite offered.

One of the biggest hill I had to climb was because of the nature of evolving

code. Spine, Hem, and Spine.app the three main components in using spine

out-of-the-box was missing some options to let an app built with the one

`spine app myApp` command. To explain this I created this sample to show the

step I had to take to get things running smoothly. It is assumed that many of

these issues will be resolved in future versions. However as of the writing of

this the latest versions have not been published and the fixes were over 3

months old. What this means is that the code you get from the node repository

is about 3 months out of date and that is the crux of the problem.

#### Declaimer ####

Please understand that this documentation is dated information and will be

obsolete as new versions of spine and hem are released.

[hem]: https://github.com/maccman/hem

[spine]: https://github.com/maccman/spine

[spine-app]: https://github.com/maccman/spine.app

[coffee-script]: http://coffeescript.org/

## Setup ##

The latest versions are available on [github](http://github.com) and you have

to specifically tell npm to install from the git repository and not the npm

registry as they are out of date.

    $ sudo npm install -g git://github.com/maccman/spine.app.git

This will instal the latest edge version of Spine.app and spine. It also

installs version **0.1.9** of hem (which is out of date as well) so we will

upgrade hem:

    $ sudo npm install -g git://github.com/maccman/hem.git

Now you are ready to create your first application:

    $ spine app myApp

## gitignore ##

The ignore file for git is missing in the initial creation. This is minor but

gets confusing so I add a sane ignore file. Please see [this article][1] on a

discussion of whether you sould ignore the node_modules are not. I choose not

to since _this sample_ is designed to show you how to install the edge version

of modules. However my normal app include it.

[1]: https://gist.github.com/3854887

## Installing edge modules ##

Open up the `package.json` file and change the hem and spine dependencies to

their github repositories.

* `"hem": "git://github.com/maccman/hem#master"`

* `"spine": "git://github.com/maccman/spine#master"`

These replace the already defined versions numbers such as `"~0.1.8"` or

`"~1.0.7"`.

    {

      "name": "app",

      "version": "0.0.1",

      "dependencies": {

        "serveup": "~0.0.5",

        "hem": "git://github.com/maccman/hem#master",

        "es5-shimify": "~0.0.1",

        "json2ify": "~0.0.1",

        "jqueryify": "~0.0.1",

        "spine": "git://github.com/maccman/spine#master"

      }

    }

## Remove getting started script ##

As the docs explain you have to remove the getting started script. **Delete**

the two lines in `public/index.html`:

    

    

## Rename the application ##

A newly created spine app defaults to the descriptive name of **app**. You have

to manually edit the `package.json` file to name the app as you did above in

the `spine app myApp` command.

    {

      "name": "myApp",

      "version": "0.0.1",

      /* ... snipped ... */

    }

## Sanity check before you start coding ##

If you wish to check that all the cogs are working together, fire up the hem

server and navigate to the two pages. Since nothing is set to run you won't get

any visual feed back but open the JavaScript console to make sure everything

loaded without any error messages.

    $ hem server

Look at http://0.0.0.0:9294/ and http://0.0.0.0:9294/test/

## Final thoughts ##

I wrote this to document the steps I have to take to get a spine application

out-of-the-box running. I found that the tests were severly broken and needed

the latest. According the git repository the commits that fix this issue is

more than 3 months old however the latest version (0.1.9) was released before

those commits and that is why the latest HEAD needed to be used.

Also when you run `npm install .` it will install the binarys into

`./node_module/.bin` therefor if you did not install hem via github then you

are required to run it from the node_module directory instead.

    $ ./node_module/.bin/hem server