Keep track of the tools you need to do your job.
https://netsyms.com/apps/binstack
You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
|
6 years ago | |
---|---|---|
lang | 6 years ago | |
lib | 6 years ago | |
mobile | 6 years ago | |
nbproject | 6 years ago | |
pages | 6 years ago | |
static | 6 years ago | |
.gitignore | 7 years ago | |
.gitmodules | 7 years ago | |
LICENSE.md | 6 years ago | |
README.md | 6 years ago | |
action.php | 6 years ago | |
api.php | 6 years ago | |
app.php | 6 years ago | |
composer.json | 6 years ago | |
composer.lock | 6 years ago | |
index.php | 6 years ago | |
pages.php | 6 years ago | |
required.php | 6 years ago | |
settings.template.php | 6 years 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.
Program Structure
Folders
- lang
Translations and alert messages.
The language file that is loaded depends on the value of
LANGUAGE
insettings.php
. Translate the values (but not the keys) inen_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 namefoo
, there should be afoo.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 deletehome.php
or404.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, includingdieifnotloggedin()
,is_empty($var)
, andlang('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 argumentmsg
to a message ID fromlang/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 tohome
will show the iconfa-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 ofsuccess
,info
,warning
, ordanger
(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.