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.
To run this project you need to have:
- Ruby 2.1.2
IMPORTANT: Make sure you have postgresql-contrib (Aditional Modules) installed on your system.
Setup the project
Clone the project
$ git clone https://github.com/catarse/catarse.git
Enter project folder
$ cd catarse
$ 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
Create and seed the database
$ rake db:create db:migrate db:seed
If everything goes OK, you can now run the project!
Setup the project w/ Docker
After building the image, you will need to install the front-end dependencies.
A most likely out of date image is available on the public docker hub, leprechaun/ruby-catarse
docker-compose up should provide what you need to be up and running. If not, look that the sections below.
docker run -d --name postgres -p 5432:5432 leprechaun/postgres-contrib
docker run -d --name redis -p 6379:6379 redis
docker run -ti -vpwd
:/app/ --link redis:redis --link postgres:postgres leprechaun/ruby-catarse
From within the container
Running the project
$ rails server
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.
Currently, we support MoIP, PayPal and WePay through our payment engines. Payment engines are extensions to Catarse that implement a specific payment gateway logic.
The current working engines are:
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
Our Pivotal is concerned with user visible features using user stories. But we do have some features not visible to users that are planned such as:
- Turn Catarse into a Rails Engine with customizable views.
- Make an installer script to guide users through initial Catarse configuration.
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.
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.
Copyright (c) 2011 Softa
Licensed under the MIT license (see MIT-LICENSE file)