search

amigosdapoli / donation-system

System that collects and manages donations for non profit organizations
GNU Affero General Public License v3.0
9 stars 5 forks source link
donations non-profit-organizations recurring-donations

readme

donation-system (name yet to be defined)

Latest Release Travis-CI Maintainability Test Coverage

Donation system is an open source project to help non profit organizations to easily collect and manage one-off and recurring donations via credit card, invoice or other payment methods. The project is being developed to help Amigos da Poli with the challenge making donations interface user friendly and easier to manage.

Here is how the system will initially work: one page where donors can fill in information and register a one-off or a recurring donation and an admin page where the non profit fundraising responsible is able to easily consolidate all donation to the organization.

The goal of this project is to help other endowment funds and non profits in general to have an effective and low cost donation system. As an open source project, we expect it can also help other non profit organizations to leverage financial resources and increase its impact in society.

 

Installation

Requirements

If in Debian/Ubuntu

# Install Postgres
sudo apt-get update
sudo apt-get install python-dev libxml2-dev libxslt1-dev build-essential libssl-dev libffi-dev zlib1g-dev
sudo apt-get install postgresql postgresql-contrib 
sudo apt-get install python-pip

# Set up database
bash scripts/setup_database_linux.sh

If in Mac

# Install Postgres
brew update
brew install postgresql

# Start the postgres service
pg_ctl -D /usr/local/var/postgres start && brew services start postgresql

# Set up database
psql postgres
=>CREATE DATABASE poscad;
=>CREATE USER admin WITH PASSWORD 'admin' ;
=>ALTER ROLE admin SET client_encoding TO 'utf8';
=>ALTER ROLE admin SET default_transaction_isolation TO 'read committed';
=>ALTER ROLE admin SET timezone TO 'UTC-3';
=>GRANT ALL PRIVILEGES ON DATABASE poscad TO admin;

Start

# Clone repo
git clone https://github.com/amigosdapoli/donation-system.git
cd donation-system/

# Install requirements 
virtualenv -p python3 venv
source venv/bin/activate
pip install -r requirements.txt

Continue

# Run start database
python manage.py makemigrations
python manage.py migrate

#Run application
python manage.py runserver

TODO using docker? Vagrant?

Payment Gateways

Payment gateways will follow a pattern so we can add different services if needed.

Available gateways

Configuring payment gateway

Set the following environment variables

GATEWAY_SANDBOX=<boolean>
MERCHANT_ID=<id>
MERCHANT_KEY=<key>

Contributing

To contribute:

  1. Fork it
  2. Create your feature branch ('git checkout -b ')
  3. Commit your changes ('git commit -am 'Add some feature')
  4. Push to the branch ('git push origin my-new-feature')
  5. Create a new Pull request

License