Developers

Getting started

The ProudCity Platform is licensed under the GNU Affero General Public License Version 3, and we welcome all developers to join us in helping to make it better.

We have extensive developer documentation available in our GitHub Docs. The basic process is to:

1. Clone the ProudCity repo
2. Run composer install
3. Install WordPress
4. Install third-party and ProudCity WordPress Plugins

We also have a version of the code pre-built and a basic database dump available at starter.proudcity.com.

APIs

All of the content entered in ProudCity is fully-accessible via the WordPress REST API. Examples:

• Retrieve Answer topics
  • In the wild: https://www.cityofsanrafael.org/wp-json/wp/v2/faq-topic
• Retrieve Answer posts:
  • In the wild: https://www.cityofsanrafael.org/wp-json/wp/v2/questions
• Retrieve Payment types:
  • In the wild: https://www.cityofsanrafael.org/wp-json/wp/v2/questions

With these APIs, it is possible to create applications that work on a number of devices:

• Kiosk tablet: City of San Rafael Kiosk

Credits

ProudCity is built on the shoulders of open source giants. We would not be possible without WordPress, and all of the open source projects it depends on, Bootstrap, Angular, Kubernetes and a host of other open source projects. We are also indebted to a number of open source WordPress plugins that are used throughout the ProudCity distribution.

Freedoms

The ProudCity WordPress distribution is licensed under GNU Affero General Public License Version 3. We agree with the WordPress statements on your rights as an open source user.