Skip to content
The first open source crowdfunding platform for creative projects in the world
Branch: develop
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci use stretch on circleci of catarse repo May 14, 2019
.magick added imagetragick sec fixes May 4, 2016
app chargeback subscription should sent request before Jul 3, 2019
bin add default rails 4.2 config Oct 19, 2016
config Mary, Mulheres vs Monstros, Balburdia e Pathfinder at home banner Jul 11, 2019
db using view to retrieve the data from unsubscribes of a project by user May 14, 2019
deploy Adds production docker-compose file Aug 18, 2016
doc adding notification examples to repo Apr 29, 2014
lib rollback admin balance transfer processing Jun 18, 2019
old-docker-config move legacy docker instructions to old-docker-config config Apr 4, 2018
public fixing typo in maintenance page May 24, 2018
spec fix specs Jul 5, 2019
vendor added the default folder for assets May 5, 2012
.buildpacks Adds node.js to Heroku build Jun 1, 2015
.dockerignore merged package-lock.json May 14, 2019
.gitignore ignore package-lock Nov 23, 2017
.python-version only validate birth_date when user account_type is pf Mar 8, 2017
.rspec reset dev May 17, 2012
.ruby-version update ruby to 2.4.4 Apr 4, 2018
.travis.yml Updates ruby to 2.2.3 Sep 9, 2015
Cheffile
Cheffile.lock Fix display :99.0 not being configured on Vagrant Feb 27, 2013
Gemfile faker on sandbox env May 14, 2019
Gemfile.lock merged package-lock.json May 14, 2019
MIT-LICENSE Updated the Copyright year on the license and readme to 2016 Jan 8, 2016
Procfile add worker to refresh project metric storage after project are created May 14, 2019
README.md Update README.md Oct 18, 2018
Rakefile run rubocop analyser Jun 1, 2017
Vagrantfile run rubocop analyser Jun 1, 2017
app.json Adds app.json to use Heroku Review Apps feature Jun 2, 2015
config.ru run rubocop analyser Jun 1, 2017
dev.Dockerfile merged package-lock.json May 14, 2019
package.json update mithril-postgrest Mar 17, 2018
run_specs add service to run catarse specs using docker-compose May 13, 2019

README.md

THIS REPO IS DEPRECATED, PLEASE SEND ALL PULL REQUESTS TO https://github.com/common-group/services-core INSTEAD.

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

      $ npm install
    

    Requires Node.js and its package manager, npm.

  • 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 below.

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

List of payment enginees that are being developed or need to be developed further

https://github.com/catarse/catarse_pagarme (payment engine used by Catarse.me)
https://github.com/devton/catarse_paypal_express (currently out of date and not maintained)
https://github.com/sushant12/CatarseStripe (just starting to be developed and needs extra hands -- please pitch in...)

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)

You can’t perform that action at this time.