Green Jobs Explorer

A web app to explore analysis to measure and identify green jobs.

Getting started

These instructions will get a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

Ruby (see .ruby-version) and PostgreSQL.

Local setup

1. Clone the repo, i.e. git clone https://github.com/nestauk/asf_green_jobs_site.git
2. Navigate to the root directory of the project.
3. bundle install to install Ruby dependencies.
4. bin/dev to start a local development server.

If you need to import an existing database you can use a utility like pg_restore.

Importing data

The /lib/tasks/import.rake allows a properly structured CSV file to be used to import data into the app.

Deployment

We currently use Heroku to host and deploy this app.

Contributing

First of all, thank you for your help!

Be sure to check out the projects open issues to see where help is needed - those labeled good first issue can be a good place to start.

Bugs

If you've spotted a bug please file an issue and apply the bug label. Even better, submit a pull request (details below) with a patch.

Pull requests

If you want a feature added the best way to get it done is to submit a pull request that implements it...

1. Fork the repo
2. Create your feature branch (git checkout -b my-new-feature)
3. Implement your changes
4. Commit your changes (git commit -am 'Add some feature')
5. Push to GitHub (git push origin my-new-feature)
6. Create a pull request into the main branch

Alternatively you can submit an issue describing the feature.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.