Difference between revisions of "Mudball"
(→Links) |
|||
Line 72: | Line 72: | ||
== Links == | == Links == | ||
− | N/A | + | N/A at the present time. |
= Specifications = | = Specifications = |
Revision as of 07:43, 14 April 2021
Mudball is the ProgClub web framework/toolkit software. That's the software that helps John deliver web-based database systems. It's a highly experimental and dynamic code base, not ready for public consumption. This project is a replacement for its predecessor PHPBOM. For other projects see projects.
Status
We use semantic versioning. Latest production version: unreleased. Latest development version: 0.1.
See TODO for work that still needs to be done.
Motivation
Why this software? Because I want a web framework and toolkit I can use to deliver data driven web applications that I completely understand and does what I want.
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 © 2021, Contributors.
License
All Rights Reserved.
This will probably be released under an open-source / free software license one day, but not yet.
Components
Libraries, tools, services, or media from third parties used under license:
- LAMP stack (Linux, Apache, MySQL/MariaDB, PHP)
- SQLite
Resources
Data sources
URI schemes
We support URI schemes as listed here: https://www.iana.org/assignments/uri-schemes/uri-schemes.xhtml
Country codes
We support ISO 3166 country codes as listed here: https://www.iban.com/country-codes
Downloads
There are no downloads at this time.
Source code
The repository can be browsed online:
https://www.progclub.org/pcrepo/mudball/branches/0.1
The latest stable released version of the code will be available from:
https://www.progclub.org/svn/pcrepo/mudball/tags/latest/0.1
Or if you want the latest version for development purposes:
https://www.progclub.org/svn/pcrepo/mudball/branches/0.1
Links
N/A at the present time.
Specifications
Functional specification
The functional specification describes what the project does.
Technical specification
The technical specification describes how the project works.
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: this software is not ready for you yet, sorry.
Notes for developers
If you're looking to set up a development environment for this project here's what you need to know.
Get the latest code from the version branch:
$ svn checkout https://www.progclub.org/svn/pcrepo/mudball/branches/0.1 mudball-0.1
You need to install and configure svnman, then you can then run the unit tests like this:
$ cd mudball-0.1 && run-tests
Note that you may need to install some dependencies, such as:
# apt install php-cli
Note that presently we are not accepting patches for this project.
Notes for administrators
To release a version of this project use svnman:
First, run maintenance and commit any changes:
$ svnman sync
Then run the release:
$ release
You will be prompted to update the project documentation.
Generated documentation
N/A at the present time.