(JIRA is currently hardcoded to work with Siteworx's internal JIRA instance during development of this project) The frontend is written in jQuery and is entirely dynamic. The frontend makes ajax calls to the backend. The backend is a RESTful web service with an API described here: API Doc The backend is written in Sinatra with a relational database mapped by DataMapper. The database is Sqlite in development and Postgres in production.
Pusher is used to push changes to the frontend.
The whole project is set up to be deployed in a Heroku instance. It could be modified to run on another server, however.
To install the required gems run
bundle install
Note that this may take several minutes
Start the server with
ruby server.rb
Or, in development
shotgun server.rb
which will cause the server to restart on every request.
- Setup a Heroku app.
- Install the Postgres addon
- Make the Postgres database url you were assigned the default DATABASE_URL
- Install the pusher add-on
- Add Heroku as a remote for git
git push heroku
Ruby and the bundler gem. Bundler will install all other required components. A Heroku account is preferred, though it may run in other environments with some configuration.