Skip to content

Coding Standards

Daniel Bezuidenhout edited this page Jun 27, 2023 · 1 revision

General Standards

  • File Names: Dash case; Class and Interface Names: Pascal Case; Variable and Function Names: Camel Case
  • The first bracket of a function must be on the same line as the function name at its definition.
  • UI pages are generated with the .page.html extension and components are generated with .component.html extensions

Repository Structure

  • Majority of the codebase resides in the src folder.
  • In this folder, the assets folder contains assets such as the logo used throughout the lap.
  • The app folder in src contains the core code for the app.
  • The actions folder contains the actions that can be dispatched in the application.
  • The auth folder contains code for validation and authentication such as logging in.
  • The models folder contains the interfaces for the application
  • The pages folder contains the main page elements/components of the app
  • The repository folder include all files relating to interactions with the database
  • The services folder contains services utilized throughout the app.
  • The state folder contains files relating to state management.
Clone this wiki locally