Ferreteria: Difference between revisions

From Woozle Writes Code
Jump to navigation Jump to search
(reorg)
No edit summary
Line 1: Line 1:
<hide>
[[Ferreteria]] is a web application framework I'm writing in PHP. It originally emerged from writing [[VbzCart]], when I realized a lot of the classes and techniques I'd created (starting with the database classes) could be used for other applications as well.
[[page type::article]]
[[thing type::software]]
[[thing type::project]]
[[software type::library]]
[[language::PHP]]
[[category:software]]
</hide>
==About==
'''Ferreteria''' is a code library that provides a basic [[application framework]] along with some utility functions that can be used separately. It was originally written for [[VbzCart]], but became useful in its own  right as it developed. The name literally means "hardware" in Spanish; I used it because I came across the word in a hardware store full of useful tools, which made it seem somehow appropriate as a name for a software toolkit, and also because I seem to be using the affix "ferret" in a lot of my software projects.


It is written in [[PHP]], but should be portable to other languages without too much difficulty.
Because it does not use JavaScript (JS), it is very fast; response-times tend to be comparable to a "single-page app" framework written in JS, except that the initial load is as quick as subsequent reloads and all of the navigation links are bookmarkable.
{|
==Features==
|-
* '''User management'''
|
** log-in control: email-based account creation, password reset
==Pages==
** user-group assignment, group-permissions assignment
* [[/install]]
* '''State persistence via URL'''
* [[/errors]]: elaboration on various error messages
** The only cookie stored is a single "session" cookie, which usually just stores the minimum needed for session security.
* [[/archive]]: obsolete pages
*** Most app-state data is stored in the URL path, without even using the <code>?query</code> part of the URL, for practical and aesthetic reasons.
* [[/modules]]: available drop-in modules (includes table design pages)
* '''Database wrappers'''
===versions===
** classes for different types of tables, records
versions 1-3 need to be renamed to 0.1-0.3 because they're all pre-release
** classes for handling forms, controls, data fields
** '''[[/v0.4|version 0.4]]''': recordsets split into single-row records and multiple-row recordsets; using status objects more
** functions for specific tables can be built by descending from more general classes
** '''[[/v0.3|version 0.3]]''': had to temporarily abandon several weeks of work on this in January 2019
** URL-linkable tables, records
*** [[/v0.3/class]]es
==Applications==
*** [[/v0.3/fx]] (functions)
Ferreteria applications I've written or am working on:
*** [[/v0.3/usage/forms]]: early v3 usage documentation, probably needs update
* [[Greenmine]]
** '''[[/v2|version 2]]''', 2017-2019: basically Ferreteria 1 with db.v2
** [[FinanceFerret]]
*** [[/v2/class]]: class structure
*** [[/v2/usage]]: how to do things in Ferreteria, how the pieces work
** '''[[/v1|version 1]]''' never really had much documentation
*** [[/v1/usage/forms]]
| valign=top |
==Apps/Applets==
* Greenmine:
** [[WorkFerret]]
** [[WorkFerret]]
** [[FinanceFerret]]: in redevelopment
* [[VbzCart]]
* [[VbzCart]]: online retail
* [[Wikcess]]
|}
==Reference==
==Links==
* {{htyp}}: official documentation
===Official===
* {{l/htw|HyperAdmin}}: an early (2005) description of what eventually became Ferreteria's login system
* [https://gitlab.com/woozalia/ferreteria GitLab]: official code repository
* [http://rm.vbz.net/projects/ferreteria Redmine @ vbz]: official project tracker

Revision as of 15:47, 8 March 2020

Ferreteria is a web application framework I'm writing in PHP. It originally emerged from writing VbzCart, when I realized a lot of the classes and techniques I'd created (starting with the database classes) could be used for other applications as well.

Because it does not use JavaScript (JS), it is very fast; response-times tend to be comparable to a "single-page app" framework written in JS, except that the initial load is as quick as subsequent reloads and all of the navigation links are bookmarkable.

Features

  • User management
    • log-in control: email-based account creation, password reset
    • user-group assignment, group-permissions assignment
  • State persistence via URL
    • The only cookie stored is a single "session" cookie, which usually just stores the minimum needed for session security.
      • Most app-state data is stored in the URL path, without even using the ?query part of the URL, for practical and aesthetic reasons.
  • Database wrappers
    • classes for different types of tables, records
    • classes for handling forms, controls, data fields
    • functions for specific tables can be built by descending from more general classes
    • URL-linkable tables, records

Applications

Ferreteria applications I've written or am working on:

Reference

  • HTYP: official documentation
  • HyperAdmin: an early (2005) description of what eventually became Ferreteria's login system