# Jobshop
_This README is also [available in a friendly, navigable format](http://documentup.com/jobshop/jobshop/)._

[![Gem Version](https://badge.fury.io/rb/jobshop.svg)](https://badge.fury.io/rb/jobshop)
[![Code Climate](https://codeclimate.com/github/frankjmattia/jobshop/badges/gpa.svg)](https://codeclimate.com/github/frankjmattia/jobshop)

Real-time production tracking and process evaluation in the cloud - or under your own roof.

To see a live demo, check out [jobshop.io](https://jobshop.io).

## Requirements

Jobshop only requires a few things:

  - Ruby >= 2.3
  - Rails >= 5.0
  - PostgreSQL

## Quick Installation

The Quick Installation is designed to get you up and running a local Jobshop
server with minimum effort. This instance will be ideal for evaluating Jobshop
on a small number of stations within your organization. If you would like to
deploy to a production server or create a local development instance, a few
extra considerations will need to be made. There are no guides yet but pull
requests are always welcome.

First, generate a new rails app and target the PostgreSQL adapter. The provided
application template does all the heavy lifting. It adds Jobshop to your
`Gemfile`, defines reasonable defaults in `config/secrets.yml` and a adds aroute
for the `Jobshop::Engine` to `config/routes.rb`.

```console
$ rails new my_jobshop --database=postgresql -m https://templates.jobshop.io/quick_install.rb
```

Change into the app directory.

```console
$ cd my_jobshop
```

`config/database.yml` should work out of the box however you should review it
and edit as necessary. Create the database.

```console
$ rails db:create
```
Run the newly pending migrations.

```console
$ rails db:migrate
```

Fire up your server with `$ rails s` and point your web browser to
[http://localhost:3000](http://localhost:3000)

## Bug Reports
If you discover a problem with Jobshop, we would like to know about it.

[https://github.com/frankjmattia/jobshop/issues](https://github.com/frankjmattia/jobshop/issues)

If you discover a security related bug, please do NOT use the GitHub issue
tracker. Send an email to
[frankjmattia@jobshop.io](mailto:frankjmattia@jobshop.io)

## License
Jobshop

Copyright © 2016 Frank J. Mattia

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as
published by the Free Software Foundation, either version 3 of the
License, or (at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License
along with this program.  If not, see
[http://www.gnu.org/licenses/](http://www.gnu.org/licenses/).