Skip to content

Documentation for developers

Tamaro Walter edited this page Aug 1, 2024 · 30 revisions

Documentation for developer of Townsquare:

This documentation should help you to fully understand the structure and components of townsquare. Goal is to make issue-solving and the development of new feature easy and that the changes fit in the rest of the programs logic, so that townsquare stays coherent and understandable for the future. This documentation is divided into the following sections:

  1. Overall structure

  1. Communication and how data is processed

  1. Detailed explanation of single components
  • 3.1 Townsquareevents and contentcontroller class
  • 3.2 Letter classes and orientation marker
  • 3.3 Database structure
  • 3.4 Lib and Locallib
  • 3.5 Mustache templates
  • 3.6 Javascript and external services
  • 3.7 Settings
  • 3.8 Privacy provider
  • 3.9 Tests

  1. Personal advice: 4.1 General programming logic 4.2 How to add new features 4.3 How to debug
Clone this wiki locally