Table of Contents
- Code enforcement case management
- Field inspections
- Public action request portal
- Cross-muni case and property viewing
Developer documentation contents by subsystem
N User
I Municipality
II Codebook
III Property
IV Person
V Event
VI Occperiod
VII Cecase
VIII Ceactionrequest
VIV Occapp
X Payment
XI Report
XII Blob
XIII Publicinfobundle
XIV Search
XV Workflow
XVI Analytics
XVII Data integrity
XVIII Help
XVIV UX
XX External Data
XXI Session
Permissions
As a cross-subsystem topic, the permissions strategy draws on features of User Credential objects and MuniProfile objects.
CodeNForce system documentation
CodeNForce is a JavaEE-based, open source web database application for managing municpal government code enforcement and occupancy permitting workflows. Built by Technology Rediscovery LLC and students attending the Community College of Allgheny County, CodeNForce’s geographic center is the Turtle Creek Valley on the outskirts of Pittsburgh, PA.
About this documentation
As technical documentation designed for developers, the primary audience for these pages are system administrators and developers who wish to build, edit, or maintain an existing CodeConnect instance. Sub-components of the system each have their own briefing page which links to specific files in the repo as they are explained and indexes how-to pages for various tasks.
Building codeNforce
You can build codeNforce on most any Linux system with these instructions. As a barely launched prototype, the build process is not always smooth like it might be in a fully packaged docker container. If you’re trying to build as an non project team member, you will probably need to be quite handy at the terminal.
Legacy doc pages (archive)
Code enforcement phase management and requested events
Essential documentation links and topic references
Adding utility table and new columns to a postgres table
Creating user-modifyable database queries(i.e. serching)
Managing user-muni connections mini-project
Property unit management mini-project
Writing documentation
All developer documentation is written in markdown and exists on the mater branch directory called docs
Since we are not actively working on the master branch, follow these steps
- Create a new directory on your computer and clone down this entire repo a second time.
- Open a new terminal window and navigate into this repo, and checkout the
master
branch (which is no longer the default branch, the default branch isrecovered
) - Open sublime » open folder » choose this new second repo which is where you’ll write the documentation and push like normal, but this time to the master branch
- Create one or more pages with an
.md
ending inside this directory structure to store your validation rules - You must commit your local changes and push them up to master to see the markdown rendered into html by the markdown engine on the github server
- When your page is ready, create a link to it on the
index.md
main page so others can see it
accessing the documentation
The documentation root is at https://technologyrediscovery.github.io/codenforce/