HTTPS SSH

City Council Services

City Council Open Source Project

This project is an open source implementation of certain city council services. So far, this project includes front-facing services for Pet Registration, and Hard Rubbish Collection.

These services allow any local council to accept pet registration details and payment, and handle hard rubbish collection requests using forms created in Gravity Forms.

City Council Services is in BETA production, and requires some editing and modifications before going live. Read below for more details.

This custom WordPress 4.8 implementation comes pre-installed with the following themes/plugins:

  • Customizable WordPress theme
  • Gravity Forms 2.2.3
  • Gravity Perks 1.2.18.6
  • GP Limit Dates 1.0.5
  • GP Unique ID 1.3.7
  • Gravity Forms Automatic Export to CSV Version 0.2.1
  • Gravity Forms Duplicate Prevention 0.1.5
  • Gravity Forms Survey Add-On 3.2
  • Gravity Forms Unrequire 1.0
  • Gravity Forms Westpac Quickstream Gateway 0.0.1
  • Gravity PDF 4.1.1
  • WCAG 2.0 form fields for Gravity Forms 1.5.1
  • WP Crontrol 1.5

Getting Started

NOTE: Experience setting up and configuring WordPress (and Gravity Forms) will be beneficial to anyone installing this.

Download

To start, pull down the files from this repository into a local, server-accessible directory.

Install

  • To install locally in Apache, create a VirtualHost and make sure its entry is listed in your hosts file
  • If you're installing on a shared server, upload the wordpress directory to the root of the server
  • Make sure that the wordpress directory is publicly accessible
  • Create a local database with a secure username and password
  • Import the data/city-council-services.sql file
  • Rename the wordpress/wp-config-sample.php file to wp-config.php
wp-config.php
  • Edit the wordpress/wp-config.php file to include your new database credentials
  • You will also find entries for address, pet registration, and animal databases here. Edit these to include your own.
  • Add your web site URL below
  • Add your own unique keys and salts further down the file
Logging in and Security
  • Go to your installed wordpress/wp-admin directory and login with User: admin and Password: admin
  • Create a new administrative user with a different name and your preferred password.
  • Login as the new user, and delete the old admin user.
  • Attribute all previous content to your new user account (IMPORTANT!)
Configuration

When logged into the admin area, go to General Settings and change - WordPress Address and Site Address to point to your preferred URL - Email address to be your preferred administrative email account

The theme uses the built-in WordPress Customizer to display the branding on the front-end.

To start, go to Appearance -> Customise.

From here, you can set the site title, upload a custom logo and site icon, set up and change your navigation menus, and edit the content that is displayed in the footer.

IMPORTANT

The system uses a mixture of database entries and files to send notifications out to administrators and users. These entries and files contain links, branding, and contact information that you will need to configure to suit your council.

  1. Edit each form (Forms -> Forms -> Edit), and check every "HTML Content" block included in each file. Add/modify any references you see to councils and services.
  2. Edit each forms' Confirmations and Notifications
  3. Edit each file in /wordpress/wp-content/themes/citycouncil/emails and /wordpress/wp-content/themes/citycouncil/gforms_messaging

If you find that some of your database calls are not working, you may need to edit the SQL queries that are pulling data from the auxiliary database.

To do this, you will need to edit the following files: - /wordpress/wp-content/themes/citycouncil/includes/pr_functions.php - /wordpress/wp-content/themes/citycouncil/includes/hrc_functions.php - /wordpress/wp-content/themes/citycouncil/animalBreeds.php - /wordpress/wp-content/themes/citycouncil/properties_hr.php - /wordpress/wp-content/themes/citycouncil/properties_pr.php

Running

Your site should now be running, and you can access the forms by going to the following URLs 1. {YOUR_SERVER}/services/hard-rubbish-collection 2. {YOUR_SERVER}/services/pet-registration

TODO

  • Payments testing
  • Include a child theme in case of future updates to parent theme

KNOWN ISSUES

To install and run locally without using a VirtualHost, you will need to navigate to wordpress/wp-content/themes/citycouncil/includes/, and edit the hrc_functions.php and pr_functions.php files to point the wp-config.php to your local file path.

License

GNU General Public License, version 2