Difference between revisions of "PHPBOM"

From ProgClub
Jump to: navigation, search
(Copyright)
(Source code)
 
Line 50: Line 50:
 
The repository can be browsed online:
 
The repository can be browsed online:
  
  https://www.progclub.org/pcrepo/phpbom/branches/0.1
+
  https://www.progclub.org/pcrepo/phpbom/branches/
  
 
<!-- 2017-02-23 jj5 - NOTE: removed for now, we haven't released yet!
 
<!-- 2017-02-23 jj5 - NOTE: removed for now, we haven't released yet!
Line 61: Line 61:
 
Or if you want the latest version for development purposes:
 
Or if you want the latest version for development purposes:
  
  https://www.progclub.org/svn/pcrepo/phpbom/branches/0.1
+
  https://www.progclub.org/svn/pcrepo/phpbom/branches/
  
 
== Links ==
 
== Links ==

Latest revision as of 00:41, 5 August 2019

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-2019, Contributors.

License

Licensed under the MIT license.

Components

Libraries, tools, services or media from third parties used under license:

Resources

Downloads

There aren't any downloads yet because we're still under development on our 0.1 version. When we release 1.0 we will (hopefully!) provide tarball packages. Stay tuned.

Source code

The repository can be browsed online:

https://www.progclub.org/pcrepo/phpbom/branches/

Or if you want the latest version for development purposes:

https://www.progclub.org/svn/pcrepo/phpbom/branches/

Links

Links are generated with bugslist.php:

$ bugslist --all -a= -c=s -o=sk -t=s > doc/links.wiki

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.

For now please check out the README file.

Notes

See versioning for information on our semantic version numbers.

Notes for implementers

If you are interested in incorporating this software into your project, here's what you need to know:

Grab a recent copy of the code from svn into 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. Note that generally classes cannot be used alone, so if you want support from a class load its respective module.

Notes for developers

If you're looking to set up a development environment for this project here's what you need to know:

So you want to hack on PHPBOM? Cool! Get in touch with John and we'll take it from there!

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.

  • JE 2017-02-23: created project page
  • JE 2016-12-16: created the project in svn