Skip to content
The first open source crowdfunding platform for creative projects in the world
Ruby HTML CSS JavaScript CoffeeScript
Latest commit b7fcc75 May 4, 2016 @adrianob adrianob Merge pull request #2132 from thiagocatarse/bannerhome-3may
New projects in banner home
Failed to load latest commit information.
.magick added imagetragick sec fixes May 4, 2016
app fix link permission May 4, 2016
bin Adds binstubs for rspec Aug 12, 2013
config Merge pull request #2132 from thiagocatarse/bannerhome-3may May 4, 2016
db Merge pull request #2115 from adrianob/add_cc_field Apr 27, 2016
doc adding notification examples to repo Apr 29, 2014
lib adjust listen task to find DirectMessageNotification class Apr 27, 2016
public Moves webfonts to public and remove inline fonts from CSS to improve … Sep 29, 2015
spec should not turn payment to paid when is donated [Fix #118394621] Apr 29, 2016
vendor added the default folder for assets May 5, 2012
.bowerrc Adds bower as front-end dependecies manager and updates file structure May 28, 2015
.buildpacks Adds node.js to Heroku build Jun 1, 2015
.gitignore Adds tern-port to gitignore Oct 6, 2015
.rspec reset dev May 17, 2012
.ruby-version Updates ruby to 2.2.3 Sep 9, 2015
.travis.yml Updates ruby to 2.2.3 Sep 9, 2015
Cheffile Fix display :99.0 not being configured on Vagrant Feb 26, 2013
Cheffile.lock Fix display :99.0 not being configured on Vagrant Feb 27, 2013
Gemfile bump user_notifier Apr 26, 2016
Gemfile.lock bump user_notifier Apr 27, 2016
MIT-LICENSE Updated the Copyright year on the license and readme to 2016 Jan 8, 2016
Procfile added listen worker to Procfile Mar 22, 2016
README.md Update README.md Mar 31, 2016
Rakefile Renaming it to Catarse Nov 20, 2010
Vagrantfile Update vagrant file to install ruby 2.1.2 Jul 21, 2014
app.json Adds app.json to use Heroku Review Apps feature Jun 2, 2015
bower.json Updates catarse.js version, 0.9.7 Apr 27, 2016
circle.yml Creates postgrest user in circle.yml to setup test env Jun 11, 2015
config.ru fix newrelic developer mode Feb 18, 2015
package.json test deploy with bower install in package.json Jun 2, 2015

README.md

Catarse

Circle CI Coverage Status Code Climate

The first crowdfunding platform from Brazil

An open-source crowdfunding platform for creative projects

Welcome to Catarse's source code repository. Our goal with opening the source code is to stimulate the creation of a community of developers around a high-quality crowdfunding platform.

You can see the software in action in http://catarse.me. The official repo is https://github.com/catarse/catarse

Getting started

Dependencies

To run this project you need to have:

Setup the project

  • Clone the project

    $ git clone https://github.com/catarse/catarse.git
    
  • Enter project folder

    $ cd catarse
    
  • Create the database.yml

    $ cp config/database.sample.yml config/database.yml
    

    You must do this to configure your local database! Add your database username and password (unless you don't have any).

  • Install the gems

    $ bundle install
    
  • Install the front-end dependencies

    $ bower install
    

    Requires bower, which requires Node.js and its package manager, npm. Follow the instructions on the bower.io website.

  • Create and seed the database

    $ rake db:create db:migrate db:seed
    
  • Configure the API server

    We provide authentication through JWT (JSON Web Tokens) and it can be configured by CatarseSettings into rails console.

    $ bundle exec rails console
    > CatarseSettings[:api_host] = "http://localhost:3004" # postgREST server url
    > CatarseSettings[:jwt_secret] = "gZH75aKtMN3Yj0iPS4hcgUuTwjAzZr9C" # this token is just a valid example
    

If everything goes OK, you can now run the project!

Running the project

  • Run API server

    After downloading PostgREST 0.3.x you can unpack and run the executable as bellow.

    $ ./postgrest postgres://postgrest@localhost/catarse_development -a anonymous --jwt-secret gZH75aKtMN3Yj0iPS4hcgUuTwjAzZr9C -s 1 -p 3004
    
  • Run Rails server

$ rails server

Open http://localhost:3000

Translations

We hope to support a lot of languages in the future, so we are willing to accept pull requests with translations to other languages.

Thanks a lot to Daniel Walmsley, from http://purpose.com, for starting the internationalization and beginning the English translation.

Payment gateways

Currently, we support pagarme through our payment engines. Payment engines are extensions to Catarse that implement a specific payment gateway logic.

If you have created a different payment engine to Catarse, please contact us so we can link your engine here. If you want to create a payment engine, please join our mailing list at http://groups.google.com/group/catarse-dev

How to contribute with code

Discuss your plans in our mailing list (http://groups.google.com/group/catarse-dev).

After that, just fork the project, change what you want, and send us a pull request.

Best practices (or how to get your pull request accepted faster)

  • Follow this style guide: https://github.com/bbatsov/ruby-style-guide
  • Create one acceptance tests for each scenario of the feature you are trying to implement.
  • Create model and controller tests to keep 100% of code coverage in the new parts you are writing.
  • Feel free to add specs to committed code that lacks coverage ;)
  • Let our tests serve as a style guide: we try to use implicit spec subjects and lazy evaluation wherever we can.

Credits

Author: Daniel Weinmann

Contributors: You know who you are ;) The commit history can help, but the list was getting bigger and pointless to keep in the README.

License

Copyright (c) 2016 Softa

Licensed under the MIT license (see MIT-LICENSE file)

Something went wrong with that request. Please try again.