Skip to content

The JoatU application, written in Ruby on Rails and ChaplinJS.

License

Notifications You must be signed in to change notification settings

joatuapp/joatu-app

Repository files navigation

README

Code Climate Build Status Test Coverage

About the Project

The Jack Of All Trade Universe is an online marketplace for self-organized exchanges. The JoatUnit is a currency that is generated to promote community activities such as planting community gardens or teaching classes. More information can be found at joatu.com

Contributions

If you are a Ruby on Rails or Javascript developer and are interested in contributing to JoatU we'd love to hear from you! JoatU is currently being programmed by volunteers, and another pair of hands is always welcome. Please feel free to clone or fork the library and explore the code-base. Setup instructions can be found below under "Getting Started", and if you have any issues or feedback on getting the app running, please open an issue (and tag it "development-environment", please).

We use Github Issues for bugs & issue tracking, and specifically the "help wanted" tag for issues that have been triaged and are most ready for outside help. That said, any open, unassigned bug is fair game, with the exception that issues tagged "request-for-comment" are currently under discussion and so should not be worked on.

If you fix an issue, please submit a pull request with your fix, using "fixes #<issue-number>" in the pull request body so that the issue will auto-close when your pull request is merged. If you are fixing a backend bug (Ruby) please include a unit test that will catch any regression of the fixed bug.

If you are not a programmer but still wish contribute please contact us about volunteering.

Getting Started

You can run JoatU locally by following these steps:

  • Ensure your system meets the requirements:
    • Ruby installed. (check the .ruby-version file for the exact version we're currently using!)
    • Postgress 9.3 installed, with the Postgis extension also installed.
  • Clone this repository
  • Change to the repository root: cd joatu-app
  • Run bundle install
  • Run bundle exec thor joatu setup. This will configure the database.
  • Run cp .env.sample .env. Open the .env file and adjust environment variables as appropriate.
  • Run bundle exec foreman start to start unicorn & postgres.
  • Visit localhost:8080 to view the site.

Licence

JoatU Copyright (C) 2014 - Jamie Klinger

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