The base template for the Netsyms Business Apps.
Skylar Ittner 47539de2d7 Fix bootstrap font URL 1 month ago
langs Rewrite to use classes, aligning with AccountHub 2.0 2 months ago
lib Rewrite to use classes, aligning with AccountHub 2.0 2 months ago
mobile Rewrite to use classes, aligning with AccountHub 2.0 2 months ago
nbproject Add MPL header 7 months ago
pages Rewrite to use classes, aligning with AccountHub 2.0 2 months ago
static Fix bootstrap font URL 1 month ago
tests Rewrite to use classes, aligning with AccountHub 2.0 2 months ago
.gitignore User name in navbar now links to Portal home 1 year ago
.gitmodules Convert material-color CSS to submodule 1 year ago
LICENSE.md Switch to Mozilla Public License 2.0 for code consistency 7 months ago
README.md Update README.md 1 month ago
action.php Switch to Mozilla Public License 2.0 for code consistency 7 months ago
api.php Rewrite to use classes, aligning with AccountHub 2.0 2 months ago
app.php Update Bootstrap and FontAwesome 2 months ago
composer.json Switch to Mozilla Public License 2.0 for code consistency 7 months ago
composer.lock Rewrite to use classes, aligning with AccountHub 2.0 2 months ago
index.php Update Bootstrap and FontAwesome 2 months ago
pages.php Switch to Mozilla Public License 2.0 for code consistency 7 months ago
required.php Rewrite to use classes, aligning with AccountHub 2.0 2 months ago
settings.template.php Replace reCAPTCHA with Captcheck 7 months ago

README.md

Business App Template

This is an empty (but fully functional) PHP application. It is designed to integrate with AccountHub, an account management web interface. AccountHub manages user credentials and account data, and is accessed by this app via a simple API.

Codacy badge

Program Structure

Folders

  • langs Translations and alert messages. The language files that are loaded depends on the value of LANGUAGE in settings.php. All .json files in a language folder are parsed and loaded into the dictionary (use via $Strings->get('some key')).
  • lib A good place to put helper functions that you don’t want “in the way”. All files that end with .lib.php are automatically loaded.
  • pages What it looks like. If you go into pages.php and define a page with the name foo, there should be a foo.php in here. The app checks before loading, so it will give a friendly 404 error if it doesn’t find your page. Woe to you if you delete home.php or 404.php, as those are assumed to exist for fallback behavior.
  • static CSS, JS, fonts, images…
  • vendor If you don’t know what this is about, or you don’t have it, you need to read up on Composer. Right now.

Files

  • settings.template.php App configuration. Copy to settings.php and customize. Documented with inline comments.
  • app.php Handles the web part of the app. If you have problems with too many items on the navbar, change $navbar_breakpoint. To change the navbar colors, find and edit <nav class="navbar ..., changing navbar-dark bg-blue to suit.
  • static/img/logo.svg The app logo. Should be a square, we don’t test any other sizes.
  • required.php The “duct tape” that holds the app together. Use require_once __DIR__."/required.php" at the top of every file. It loads Composer dependencies, library files, app settings, language data, and creates $database for accessing the database. It also has some utility functions, including dieifnotloggedin(). Read through it to see exactly what it does.
  • action.php A good place to put form handling code. By default it only handles logging out, but is easily expanded.
  • api.php Similar to action.php, but designed for user/pass authenticated JSON responses.
  • index.php Login page and handler. Hands off to app.php after authenticating user. It includes 2fa support, by the way.
  • app.php Main app page after login. Handles loading app pages and 404 errors. Redirects to index.php if the user is not logged in. Note: to show an alert message (success, error, whatever), set the GET argument msg to a message ID from lang/messages.php.
  • pages.php Define app pages/screens in an array. The page ID/array key is assumed to exist as a file pages/{key}.php, or it will 404. Optional parameters: 'navbar' => true will show the page as a button in the app menu bar. 'icon' => '...' will show an icon from FontAwesome in the menu bar. Setting this to home will show the icon fa-home. 'styles' => ["file.css"] will inject the listed CSS files into the page header (after all other CSS, like Bootstrap). 'scripts' => ["file.js"] will inject the listed JavaScript files into the page footer (after jQuery and other builtin scripts).
  • langs/messages.php Array of alert messages. "string" is the language string for the message, "type" is one of success, info, warning, or danger (i.e. Bootstrap alert classes). Changing the type changes the icon and color of the alert box.

Setup Tips

  • Run composer install (or composer.phar install) to install dependency libraries
  • If you don’t have any color in the navbar, run git submodule init and git submodule update.