The base template for the Netsyms Business Apps.
Skylar Ittner 963fbfbf00 Upgrade FontAwesome to 5.1.0 2 weeks ago
lang Change string 1 month ago
lib Change session ID on successful login, make sessions last at least 2 hours 2 months ago
mobile Switch to Mozilla Public License 2.0 for code consistency 3 months ago
nbproject Add MPL header 3 months ago
pages Switch to Mozilla Public License 2.0 for code consistency 3 months ago
static Upgrade FontAwesome to 5.1.0 2 weeks ago
.gitignore User name in navbar now links to Portal home 1 year ago
.gitmodules Convert material-color CSS to submodule 8 months ago
LICENSE.md Switch to Mozilla Public License 2.0 for code consistency 3 months ago
README.md Update README 3 months ago
action.php Switch to Mozilla Public License 2.0 for code consistency 3 months ago
api.php Switch to Mozilla Public License 2.0 for code consistency 3 months ago
app.php Make msg alert time out with smooth visual effects 1 month ago
composer.json Switch to Mozilla Public License 2.0 for code consistency 3 months ago
composer.lock Update dependencies 6 months ago
index.php Fix PHP variable warnings 1 month ago
pages.php Switch to Mozilla Public License 2.0 for code consistency 3 months ago
required.php Fix #2 1 month ago
settings.template.php Replace reCAPTCHA with Captcheck 3 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

  • lang Translations and alert messages. The language file that is loaded depends on the value of LANGUAGE in settings.php. Translate the values (but not the keys) in en_us.php into other languages and save in appropriately named files to add languages.
  • lib A good place to put helper functions that you don't want "in the way".
  • 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.
  • 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, app settings, language data, and creates $database for accessing the database. It also has some utility functions, including dieifnotloggedin(), is_empty($var), and lang('key'). Read through it to see what those functions do.
  • action.php A good place to post forms to. 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).
  • lang/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. *lang/en_us.php Language data for US English. *lib/login.php Functions for logging in users and stuff like that. Most functions transparently makes requests to the AccountHub API and return the results. *lib/userinfo.php Functions for getting user data, like real names and managed employees. *static/css/app.css Custom styles for the app. See the comments inside for instructions on theming the app.