https://github.com/drkane/ngo-explorer
Data tool to help international development NGOs to navigate charity commission data. Project partners: The Sheffield Institute for International Development, David Kane, CharityBase
https://github.com/drkane/ngo-explorer
charity flask international-development python python-requests
Last synced: 12 months ago
JSON representation
Data tool to help international development NGOs to navigate charity commission data. Project partners: The Sheffield Institute for International Development, David Kane, CharityBase
- Host: GitHub
- URL: https://github.com/drkane/ngo-explorer
- Owner: drkane
- Created: 2018-12-03T10:28:46.000Z (over 7 years ago)
- Default Branch: main
- Last Pushed: 2025-02-17T21:03:04.000Z (about 1 year ago)
- Last Synced: 2025-02-26T18:11:47.695Z (about 1 year ago)
- Topics: charity, flask, international-development, python, python-requests
- Language: Python
- Homepage: https://ngoexplorer.org/
- Size: 5.76 MB
- Stars: 4
- Watchers: 5
- Forks: 0
- Open Issues: 6
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
# Development Charities Data Explorer
Data tool to help international development NGOs to navigate charity commission data.
[](https://github.com/drkane/ngo-explorer/actions/workflows/pythonlint.yml)
[](https://github.com/drkane/ngo-explorer/actions/workflows/pythontest.yml)
[](https://github.com/drkane/ngo-explorer/issues)
[](https://github.com/drkane/ngo-explorer)
## Project partners:
- [Global Development Institute (GDI, University of Manchester)](http://siid.group.shef.ac.uk/)
- [Sheffield Institute for International Development (SIID, University of Sheffield)](https://www.gdi.manchester.ac.uk/)
- [David Kane](https://dkane.net/)
- [Find that Charity](https://findthatcharity.uk/)
## About this app
This app uses [Flask](http://flask.pocoo.org/) to fetch and display data from
[Find that Charity](https://findthatcharity.uk/).
## Installing app using dokku
On dokku server:
```bash
# create app
dokku apps:create ngo-explorer
# enable domains
dokku domains:enable ngo-explorer
dokku domains:add ngo-explorer example.com
# letsencrypt
dokku plugin:install https://github.com/dokku/dokku-letsencrypt.git
dokku config:set --no-restart ngo-explorer DOKKU_LETSENCRYPT_EMAIL=your@email.tld
dokku letsencrypt ngo-explorer
# setup volume storage
mkdir -p /var/lib/dokku/data/storage/ngo-explorer
chown -R dokku:dokku /var/lib/dokku/data/storage/ngo-explorer
chown -R 32767:32767 /var/lib/dokku/data/storage/ngo-explorer
dokku storage:mount ngo-explorer /var/lib/dokku/data/storage/ngo-explorer:/app/storage
dokku config:set --no-restart ngo-explorer DATA_CONTAINER=/app/storage
```
## Styles
A custom build of tachyons is maintained in .
Colours used include:
- yellow: `#f9af42` 
- dark-green: `#043942` 
- green: `#237756` 
- light-green: `#0ca777` 
## Translations
Update translations if base text changes
```
pybabel extract -F babel.cfg --copyright-holder="NGO Explorer" --project="NGO Explorer" --msgid-bugs-address="email@example.net" -o messages.pot .
pybabel update -i messages.pot -d translations
```
Create a file for translations
```
pybabel init -i messages.pot -d translations -l de
```
Compile the new transations
```
pybabel compile -d translations
```
## Compile javascript
We use webpack and [babel](https://babeljs.io/setup#installation) to compile javascript - this
minimises the size of the javascript files, and makes sure that we can target older
browsers.
```
npm run build
```
## Run tests
```
python -m pytest -p no:warnings
```