/nfscan

NFScan is a free, open-source software, available to non-profit organizations to receive donations effectively.

Primary LanguageJavaMIT LicenseMIT

nfscan

Build Status GitHub license

NFScan is a free, open-source software, available to non-profit organizations to receive donations effectively.

FAQ

Frequent asked questions in Portuguese

What's new in this version

  • Create Cloudformation templates to allow easy deploy by anyone with an AWS account.
  • Access AWS resources using IAM roles instead of hardcoded accessKeys and secretKeys.
  • Remove references to BasicCredentials since we're gonna use AWSCredentialsChain for that.
  • Parameterize backend username and password.
  • Upgrade AWS sdk to 1.11.44.

Looking for older versions changes? Please take a look at CHANGELOGS.md

Quickly deploy nfscan to AWS

The easiest way to deploy nfscan to AWS is through the use of a Cloudformation template. It allows the required infrastructure and dependent services to be provisioned with little to none knowledge of AWS.

The table below shows different regions where you want to deploy nfscan. There are numerous factors that you could take into consideration when deciding which one you're going to launch it. However, if your primary concern is about how much it's gonna cost then either N. Virgina and Ohio will be a good call. If low latency is a requirement, then São Paulo will be a better option.

Region Name Region Action
US East (N. Virginia) us-east-1
US East (Ohio) us-east-2
US West (N. California) us-west-1
US West (Oregon) us-west-2
Asia Pacific (Mumbai) ap-south-1
Asia Pacific (Seoul) ap-northeast-2
Asia Pacific (Singapore) ap-northeast-1
Asia Pacific (Sydney) ap-southeast-2
Asia Pacific (Tokyo) ap-southeast-1
EU (Frankfurt) eu-central-1
EU (Ireland) eu-west-1
South America (São Paulo) sa-east-1

Setting up development environment

Walkthrough in Portuguese

Public API

Once you've set up your development enviroment you can make calls to nfscan's public API to process or donate receipts. We've created a wiki page containing all requests you should use in order to integrate with whatever app/site of yours.

Mobile

We've made an open source app for iOS that integrates with nfscan. You may use it as a reference model or even as a white label product. That's up to you.

Awards

[Bronze] :: Cannes Lions - Cyber Category [Estrela Verde] :: CCSP - Ação beneficiente [Grand Prix] :: B9 2015

Contributing

You're encouraged to contribute to nfscan. Fork the code from https://github.com/nfscan/nfscan and submit pull requests.

Make sure you're following the contributing guidelines for this project.