Difference between revisions of "PHPBOM"
(Adding initial project documentation...) |
m (→Functional specification: typo) |
||
Line 65: | Line 65: | ||
== Functional specification == | == Functional specification == | ||
− | The functional specification describes what the project does. The software is a web framework and toolkit | + | The functional specification describes what the project does. |
+ | |||
+ | The software is a web framework and toolkit for delivering web applications and web services in PHP. | ||
== Technical specification == | == Technical specification == |
Revision as of 05:03, 23 February 2017
PHPBOM is the ProgClub PHP web-framework and toolkit. That's the software we use to develop web applications and web services in PHP. It's a mashup of bits and pieces John thinks are useful when delivering software for the web! For other projects see projects.
Status
We use semantic versioning. Latest production version: unreleased. Latest development version: 0.1.0.
See tasks for work that still needs to be done.
Motivation
Why this software? Because it's a good place to store useful bits and pieces that I (we?) probably want to reuse across all the web projects that I (we?) do.
Administration
Contributors
Members who have contributed to this project. Newest on top.
All contributors have agreed to the terms of the Contributor License Agreement. This excludes any upstream contributors who tend to have different administrative frameworks.
Copyright
Copyright © 2017, Contributors.
License
Licensed under the MIT license.
Components
Libraries, tools, services or media from third parties used under license:
- TODO: list 'em
Resources
Downloads
TODO: link to downloads or explain why there aren't any.
Source code
The repository can be browsed online:
https://www.progclub.org/pcrepo/phpbom/branches/0.1
The latest stable released version of the code will be available from:
https://www.progclub.org/svn/pcrepo/phpbom/tags/latest/0.1
Or if you want the latest version for development purposes:
https://www.progclub.org/svn/pcrepo/phpbom/branches/0.1
Links
No links at this time.
Specifications
Functional specification
The functional specification describes what the project does.
The software is a web framework and toolkit for delivering web applications and web services in PHP.
Technical specification
The technical specification describes how the project works.
TODO: add a bit of a tech-spec.
Notes
Notes for implementers
If you are interested in incorporating this software into your project, here's what you need to know:
Notes for developers
If you're looking to set up a development environment for this project here's what you need to know:
Grab a recent copy of the code from svn in to a /lib/phpbom-0.1 directory in your project. Then depending on what framework or features you want include the appropriate files. For frameworks see src/framework, for utilities see src/util, and for modules see src/module. Not that generally classes cannot be used alone, so if you want support from a class load its respective module.
See versioning for more information on our semantics version numbers.
Notes for ProgClub administrators
To release a version of this project use the pcrepo-branch-release script from the jj5-bin project:
$ pcrepo-branch-release phpbom $MAJOR.$MINOR $PATCH
Where:
$MAJOR = the major version number, presently 0 $MINOR = the minor version number, presently 1 $PATCH = the patch number for this release
See status for last production release.
Tasks
TODO
Things to do, in rough order of priority:
- create a TODO list... :P
Done
Stuff that's done. Latest stuff on top.