https://github.com/mefellows/sinatra-angular-seed

Sinatra and Angular Seed project: Get started with Sinatra-ng on Heroku ASAP!
https://github.com/mefellows/sinatra-angular-seed

Last synced: about 2 months ago
JSON representation

Sinatra and Angular Seed project: Get started with Sinatra-ng on Heroku ASAP!

• Host: GitHub
• URL: https://github.com/mefellows/sinatra-angular-seed
• Owner: mefellows
• Created: 2014-05-31T15:47:52.000Z (over 10 years ago)
• Default Branch: feature/alpha
• Last Pushed: 2014-06-08T09:10:35.000Z (over 10 years ago)
• Last Synced: 2024-10-11T22:55:16.541Z (2 months ago)
• Language: Ruby
• Size: 227 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Sinatra + Angular Seed

Get started hacking Sinatra and Angular on Heroku ASAP.

Out of the box, you get:

* Opinionated default setup of a Sinatra Web Application

* API with CORS, Sockets and JSON Support

* CLI Support

* Heroku configuration

* Unit Tests

* Standard Gem setup

# Getting started

## Pull down the seed and start the app

    git clone https://github.com/mefellows/sinatra-angular-seed.git

    cd sinatra-angular-cd

    echo 'PORT=8080' > .env && bundle install

    foreman start

Test that we're up:

    curl  "http://localhost:8080/status"

All going to plan, you should see ```alive``` indicating the app is running.

Setup the UI

    cd public

    npm install && bower install && grunt

    grunt serve

    

View your Web front end by visiting ```http://localhost:8080/``` in your favourite web browser.

You will want to change the name of files/folders from 'placeholder' to the name of your app. If you have the 'rename' command, this is the quickest way forward (```brew install rename``` if you don't have it and are running Mac OSX). Create and run this little helper:

vi rename.sh

    #!/bin/bash

    

    find . -type f -iname '*placeholder*' | grep -v '\.git' | xargs rename 's@placeholder@@gi' {}

    find . -type d -iname '*placeholder*' | grep -v '\.git' | xargs rename 's@placeholder@@gi' {}

    find . -type f | grep -v '\.git' | xargs sed -i 's/placeholder//g'

    find . -type f | grep -v '\.git' | xargs sed -i 's/Placeholder//g'

Add execute perms

    chmod +x rename.sh

    ./rename.sh

    

Alternatively, you can change them manually yourself.

## Testing

    rake

## Deploying to Heroku

You will of course need to create an app in Heroku before deployment, a typical setup would look like:

    heroku app:create 

    heroku config:set BUILDPACK_URL=https://github.com/ddollar/heroku-buildpack-multi.git

    heroku labs:enable websockets

    git push heroku master

## Logging

By default, we log to the stdout stream (as per Heroku's guide: ). If you'd like to change this behaviour, set the ```LOG_OUTPUT_FILENAME``` environment variable:

    $ bin/placeholder  magic http://www.onegeek.com.au/

     INFO placeholder.placeholdercommand: Magic happens!

    $ export LOG_OUTPUT_FILENAME='placeholder.log'

    $ bin/placeholder  magic http://www.onegeek.com.au/

    $ cat placeholder.log

     INFO placeholder.placeholdercommand: Magic happens!

# TODO

* Yeoman Generator: This might eventually turn into a Yeoman generator, meaning an interactive CLI will guide you through a setup instead of a static clone.

* Docker/Puppetize: For deployment to a non-Heroku environment, Puppet and Docker are popular alternatives.

# Acknowledgements

* Sinatra

* Eventmachine

* Foreman

* Angular