Skip to content
Permalink
Branch: master
Find file Copy path
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
134 lines (106 sloc) 5.81 KB

UK Charity Database and Browser

Builds a geocoded database of UK charities and companies and provides a web page to find charities, companies and volunteer opportunities in an area. The intention is that local charities and businesses can find each other an collaborate to drive up volunteering and giving back.

Further background on this project can be found here.

Issues and ideas can be found here.

Setup

Node.js

Make sure you have Node.js and the Heroku Toolbelt installed.

$ git clone <this repository>
$ cd nodejs
$ npm install

API keys

Obtain a companies house api key from here

Obtain a google geocode api key from here

Database

Create a firebase app here

Add the initial counters to your database through the firebase dashboard

counters
|
+-charity
|   |
|   +-start: 200000
|   |
|   +-next: 200000
|   |
|   +-end: 1200000
|
+-company
    |
    +-start: 118
    |
    +-next: 118
    |
    +-end: 1000000

Use the firebase console to obtain your database secret

Set your firebase security rules using the dashboard. Some basic settings are provided below.

{
    "rules": {
        ".read": true,
        ".write": false,
        "feature" : {
          "charity" : {
            ".indexOn": ["g"]
          },
          "company" : {
            ".indexOn": ["g"]
          }
        }
    }
}

Post code locations

Download an initial set of post code locations. One possible source is the csv file here.

Local running

Create a .env file to define environment variables for local running.

CLEANUP=0 \\not currently used
MAPINTERVAL=0 \\not currently used
MAPBATCH=500 \\maximum number of organisations to returned in a geographic query
CHARITY=2000 \\milliseconds to delay between queries to the charity commission API to avoid rate limits
COMPANY=2000 \\milliseconds to delay between queries to the companies house api to avoid rate limits
FIREBASEKEY=<secret> \\secret key for your firebase database
GEO=35000 \\milliseconds to delay between queries to the google geocode api to avoid rate and day limits
GOOGLEKEY=<API key> \\key for your google api account
COMPANYKEY=<Companies house API Key> \\key for your companies house account

Run a local version of the application using the heroku toolbelt

$ heroku local

Your app should now be running on localhost:5000.

Deploying to Heroku

$ heroku create

Define the environment variables using the heroku console or use the heroku cli.

$ heroku config:set ... = ...

Deploy to heroku via git push

$ git push heroku master
$ heroku open

or

Deploy to Heroku

Documentation

For more information about using Node.js on Heroku, see these Dev Center articles:

Background

This idea started a few months ago at a government sponsored "Civic Hack". One of the challenges that was identified was that many charities were struggling to tap into business skills (such as financial planning) and companies were willing to offer more support. The obstacle was how to match this demand and supply. Services like Team London satisfied part of this need but, because there are a lot of these sorts of portal, charities often publish their requirements in one place and volunteers declare their availability somewhere else. Another obstacle is that the volunteering portals use filters like, local authority areas, which are not very user oriented. I have been exploring other ways of making this information accessible to people to drive up successful volunteering.

The current BETA app illustrates one way of doing this. Using registered office addresses medium sized charities and companies could see who their neighbours are and reach out to collaborate. Registered offices does not work so well for very small organisations (who probably use the office address of their accountant) or very large ones (which will only show an administrative head office).

I am currently talkng to the developers behind Team London and similar sites to see if they will make their registers of volunteers and volunteering opportunities available in a similar form.

On-going Development

  • Upload details of volunteers and volunteer opportunities from volunteering portals (with permission). Do-It has been included and other portals are considering the idea.
  • Provide a way for charities, companies and individuals to provide information not held in existing registers (e.g. regional and local offices)
  • Allow people to filter results by type of voluntary activities or time.
  • Provide a way for people to donate additional resources (e.g. hosting, geocoding) rather than create a separate instance. Requires providing limited firebase database access without exposing keys.
  • Define an open standard for exchange of volunteering information, possibly based on the job posting standard, so that charities can publish what they need and companies and individuals can publish what they can offer.
You can’t perform that action at this time.