ckanext-lacounts
CKAN extension for the LA Counts project
Requirements
This extension is being developed against CKAN 2.8.x
Installation
To install ckanext-lacounts for development, activate your CKAN virtualenv and do:
git clone https://github.com/okfn/ckanext-lacounts.git
cd ckanext-lacounts
python setup.py develop
pip install -r requirements.txt
API (Get Involved page actions)
Actions for the Get Involved page are available in the CKAN Action API.
Event actions:
Available parameters:
- id: a uuid (required for some actions, see below)
- name: a string (required)
- date: a date string e.g. “2019-01-21” (required)
- free: a boolean-like, e.g. “yes” or true (required)
- url: a string url
- location: a string
- topic_tags: a list of strings, e.g. [“Housing”, “Employment”]
Running the Tests
To run the tests, do:
nosetests --nologcapture --with-pylons=test.ini
Theme development
Get dependencies with npm install.
CSS and JS are built from the src directory into the fanstatic directory.
CSS is built with PostCSS. Do so with grunt postcss.
JS is built (minified) with grunt uglify.
You can watch both for changes with grunt.
Initialize ‘Get Involved’ database tables
The ‘Get Involved’ pages require additional database tables to be initialized: events and volunteering. These are created with the following paster command.
License
AGPL-3.0