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

[![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

## Installation

Start by generating a new rails app using the PostgreSQL adapter:

```console
$ rails new my_jobshop --database=postgresql
$ cd my_jobshop
```

Add jobshop to `Gemfile`:

```ruby
gem "jobshop", "~> 0.0.3"
```

Bundle install your dependencies:

```console
$ bundle install
```

Edit `config/database.yml` if necessary, create the database and run and pending migrations:

```console
$ rake db:create
$ rake db:migrate
```

Lastly, create your first Jobshop site:

```
$ rails g Jobshop:site "My Organization Name"
```

Fire up your server `$ rails s` and navigate to the link provided by the site generator!

## 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/).