catarse 1.0.0.beta

Sign up to get free protection for your applications and to get access to all the features.
Files changed (4) hide show
  1. data/MIT-LICENSE +19 -0
  2. data/README.md +76 -0
  3. data/lib/catarse.rb +1 -0
  4. metadata +66 -0
data/MIT-LICENSE ADDED
@@ -0,0 +1,19 @@
1
+ Copyright (c) 2011 Softa
2
+
3
+ Permission is hereby granted, free of charge, to any person obtaining a copy
4
+ of this software and associated documentation files (the "Software"), to deal
5
+ in the Software without restriction, including without limitation the rights
6
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
7
+ copies of the Software, and to permit persons to whom the Software is
8
+ furnished to do so, subject to the following conditions:
9
+
10
+ The above copyright notice and this permission notice shall be included in
11
+ all copies or substantial portions of the Software.
12
+
13
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
14
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
15
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
16
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
17
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
18
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
19
+ THE SOFTWARE.
data/README.md ADDED
@@ -0,0 +1,76 @@
1
+ # Catarse [![Build Status](https://secure.travis-ci.org/danielweinmann/catarse.png?branch=master)](https://travis-ci.org/danielweinmann/catarse)
2
+ ## An open source crowdfunding platform for creative projects
3
+
4
+ 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.
5
+
6
+
7
+ You can see the software in action in http://catarse.me.
8
+
9
+ ## Getting started
10
+
11
+ ## Internationalization
12
+
13
+ This software was first created as Brazil's first crowdfunding platform.
14
+ Thus, it was first made in Portuguese and with a brazilian payment gateway.
15
+ We are now internationalizing it, and already have a good support for the english language and for paypal express checkout.
16
+ See below the Payment gateways section for more information about integrating Catarse with a payment system of your choice.
17
+ If you want to join us in this effort, please feel free to fork the repository and send us a pull request with your changes. If you have *any* doubt, please join our Google Group at http://groups.google.com/group/catarse-dev and we will help you.
18
+
19
+ ### Translations
20
+
21
+ We hope to support a lot of languages in the future. So we are willing to accept pull requests with translations to other languages. Here's a small guide to translate Catarse to your language in a way that we can integrate your translation in the main repository:
22
+ * TODO
23
+
24
+ Thanks a lot to Daniel Walmsley, from http://purpose.com, for starting the internationalization and beginning the english translation.
25
+
26
+ ## Payment gateways
27
+
28
+ Currently, we support MoIP and PayPal through our payment engines. Payment engines are extensions to Catarse that implement a specific payment gateway logic.
29
+ The two current working engines are:
30
+ * MoIP
31
+ * PayPal
32
+
33
+ If you have created a different payment engine to Catarse please contact us so we can link your engine here.
34
+ If you want to create a payment engine please join our mailing list at http://groups.google.com/group/catarse-dev
35
+
36
+
37
+ Here are some tips to get things started:
38
+
39
+ ## How to contribute with code
40
+
41
+ Before contributing, take a look at our Roadmap (https://www.pivotaltracker.com/projects/427075) and discuss your plans in our mailing list (http://groups.google.com/group/catarse-dev).
42
+
43
+ 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:
44
+ * Turn Catarse into a Rails Engine with customizable views.
45
+ * Turn Backer model into a finite state machine using the state_machine gem as we did with the Project model.
46
+ * Improve the payments engine isolation providing a clear API to integrate new payment engines in the backer review page.
47
+ * Make a installer script to guide users through initial Catarse configuration.
48
+
49
+ Currently, a lot of functionality is not tested. If you don't know how to start contributing, please help us regaining control over the code and write a few tests for us! *Any* doubt, please join our Google Group at http://groups.google.com/group/catarse-dev and we will help you out.
50
+
51
+ After that, just fork the project, change what you want, and send us a pull request.
52
+
53
+ ### Coding style
54
+ * We prefer the `{foo: 'bar'}` over `{:foo => 'bar'}`
55
+ * We prefer the `->(foo){ bar(foo) }` over `lambda{|foo| bar(foo) }`
56
+
57
+ ### Best practices (or how to get your pull request accepted faster)
58
+
59
+ We use RSpec and Steak for the tests, and the best practices are:
60
+ * Create one acceptance tests for each scenario of the feature you are trying to implement.
61
+ * Create model and controller tests to keep 100% of code coverage at least in the new parts that you are writing.
62
+ * Feel free to add specs to the code that is already in the repository without the proper coverage ;)
63
+ * Try to isolate models from controllers as best as you can.
64
+ * Regard the existing tests for a style guide, we try to use implicit spec subjects and lazy evaluation as often as we can.
65
+
66
+ ## Credits
67
+
68
+ Author: Daniel Weinmann
69
+
70
+ Contributors: You know who you are ;) The commit history can help, but the list was getting bigger and pointless to keep in the README.
71
+
72
+ ## License
73
+
74
+ Copyright (c) 2011 Softa
75
+
76
+ Licensed under the MIT license (see MIT-LICENSE file)
data/lib/catarse.rb ADDED
@@ -0,0 +1 @@
1
+ require 'spree_core'
metadata ADDED
@@ -0,0 +1,66 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: catarse
3
+ version: !ruby/object:Gem::Version
4
+ version: 1.0.0.beta
5
+ prerelease: 6
6
+ platform: ruby
7
+ authors:
8
+ - Daniel Weinmann
9
+ autorequire:
10
+ bindir: bin
11
+ cert_chain: []
12
+ date: 2013-02-04 00:00:00.000000000 Z
13
+ dependencies:
14
+ - !ruby/object:Gem::Dependency
15
+ name: catarse_core
16
+ requirement: !ruby/object:Gem::Requirement
17
+ none: false
18
+ requirements:
19
+ - - '='
20
+ - !ruby/object:Gem::Version
21
+ version: 1.0.0.beta
22
+ type: :runtime
23
+ prerelease: false
24
+ version_requirements: !ruby/object:Gem::Requirement
25
+ none: false
26
+ requirements:
27
+ - - '='
28
+ - !ruby/object:Gem::Version
29
+ version: 1.0.0.beta
30
+ description: The first open source crowdfunding platform for creative projects in
31
+ the world
32
+ email: danielweinmann@gmail.com
33
+ executables: []
34
+ extensions: []
35
+ extra_rdoc_files: []
36
+ files:
37
+ - README.md
38
+ - MIT-LICENSE
39
+ - lib/catarse.rb
40
+ homepage: https://github.com/danielweinmann/catarse
41
+ licenses:
42
+ - MIT
43
+ post_install_message:
44
+ rdoc_options: []
45
+ require_paths:
46
+ - lib
47
+ required_ruby_version: !ruby/object:Gem::Requirement
48
+ none: false
49
+ requirements:
50
+ - - ! '>='
51
+ - !ruby/object:Gem::Version
52
+ version: 1.9.2
53
+ required_rubygems_version: !ruby/object:Gem::Requirement
54
+ none: false
55
+ requirements:
56
+ - - ! '>='
57
+ - !ruby/object:Gem::Version
58
+ version: 1.8.11
59
+ requirements:
60
+ - none
61
+ rubyforge_project:
62
+ rubygems_version: 1.8.25
63
+ signing_key:
64
+ specification_version: 3
65
+ summary: An open source crowdfunding platform for creative projects
66
+ test_files: []