lvl0/incr
lvl0/incr
1
0
Fork 0
Code Issues Pull requests Releases 5 Packages Activity Actions

61 - Relicense to AGPL, add CONTRIBUTING and CHANGELOG
All checks were successful
CI / ci (push) Successful in 31s
Details
CI / build (push) Successful in 1m4s
Details
CI / ci (pull_request) Successful in 29s
Details
CI / build (pull_request) Successful in 1m2s
Details

Browse source
This commit is contained in:
myrmidex 2026-08-16 11:32:58 +02:00
parent b38a8744bb
commit 2183dff508
6 changed files with 255 additions and 81 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

76
CHANGELOG.md Normal file
View file

@ -0,0 +1,76 @@
# Changelog
All notable changes to this project will be documented in this file.
## [0.4.0] - 2026-08-16
incr began as a tracker for VWCE shares and accumulated a ledger, asset prices,
milestones, an onboarding wizard and a React frontend on the way. This release
removes all of it. What remains is a counter: click the number to add one, or
open a dialog to set it directly.
### Changed
- **The frontend is Blade and Livewire 4 instead of React and Inertia** (#52)
- `wire:click="increment"` replaces a page component, a display component, a
dialog and the fetch layer between them.
- The build output went from 2264 modules and 311 kB of JavaScript to two
modules and 13 kB of CSS. No JavaScript is shipped to the browser.
- npm dependencies went from 33 to 4: vite, tailwindcss and two plugins.
- The page now renders server-side with the count already in the HTML. There
is no loading spinner and no fetch after paint.
- **The counter is a single integer** (#50)
- It was `SUM(quantity)` over an `entries` ledger. Per-increment history was
never displayed and is deliberately not kept.
- `POST /increment` and `PATCH /count` return JSON with real status codes. The
endpoints they replaced returned redirects, which `fetch()` followed — a
validation failure reported success.
- **Onboarding is a single input for the starting value** (#51)
- It was a three-screen wizard asking for a label, a unit, a date, a quantity
and a milestone.
- A counter sitting at zero used to be indistinguishable from an unconfigured
app and was sent back to setup. The gate is now whether a counter exists.
- **CI runs in about 40 seconds instead of two to forty minutes** (#46, #57)
- PHP is baked into a prebuilt image rather than installed on every run.
- Tests run against sqlite in memory rather than a MySQL service container,
taking about a second instead of 53.
- The Composer cache path was wrong, so no packages were ever cached.
- Thirteen migrations squashed into one (#46). The chain created and dropped
nine tables to arrive at a single table, and replaying it required
MySQL-specific DDL. Existing installations are unaffected.
### Removed
- Asset and price tracking: the `Asset` and `AssetPrice` models, their
controllers, eight routes and two tables (#48)
- Milestones, the progress bar and the stats box (#49)
- The user layer. The app is single-user with no authentication, but carried a
fake user, an auth config, and `users`, `sessions` and `password_reset_tokens`
tables that existed only to be bypassed (#53)
- 51 unreachable frontend files left by the Laravel starter kit — a layout
system, a component library and an unrouted landing page, none of which any
page imported (#47)
- Stale CI: two GitHub Actions workflows targeting a branch that does not exist,
and a Jenkinsfile pointing at a registry the project left months ago (#56)
### Added
- PHPStan with larastan at level 7, clean with no baseline (#55)
- Test coverage for the counter, from 4 tests covering only milestones to 17
covering increment, set-value, validation and onboarding (#54)
### Fixed
- The 7-segment display font never loaded in development. Vite serves assets
itself, so the absolute `/fonts/` path returned 404 and the browser silently
fell back to a monospace face (#59)
- The browser tab said "Laravel" and the favicon was the framework default (#59)
- `GET /register` returned an error rather than 404: the route and controller
outlived the page component they rendered (#53)
- `container_tinker` ran expressions but discarded their return values, and
`container_db_read` invoked a MariaDB client against a MySQL container (#58)
### Note
Price tracking (#38, #35) and a dropdown fix (#17) were closed as won't-fix.
They built or repaired subsystems this release removes.

97
CONTRIBUTING.md Normal file
View file

@ -0,0 +1,97 @@
# Contributing
Thanks for your interest in incr. This is a small self-hosted project, issues and
pull requests are both welcome.
## Reporting issues
Use [Issues](https://forge.lvl0.xyz/lvl0/incr/issues).
For bugs, include what you expected, what happened, and enough detail to
reproduce it. `dev-logs` follows the application log.
Bear in mind what incr deliberately is: a single counter, incremented by clicking
it, with a dialog to set a value directly. Feature requests that add tracking,
history or goals are likely to be declined — a previous version had all three and
they were removed on purpose.
## Development setup
Requires PHP 8.2+ and Docker or Podman. The development environment runs in
containers defined by `docker/dev/docker-compose.yml`.
On NixOS, or anywhere with Nix installed:
```bash
git clone https://forge.lvl0.xyz/lvl0/incr.git
cd incr
nix-shell
```
The shell prints the available commands on entry and can start the containers
for you:
| Command | Description |
|---------|-------------|
| `dev-up` | Start the development environment |
| `dev-down` | Stop the development environment |
| `dev-restart` | Restart the containers |
| `dev-rebuild` | Rebuild the images |
| `dev-shell` | Enter the app container |
| `dev-artisan <cmd>` | Run an artisan command |
| `dev-composer <cmd>` | Run a composer command |
| `dev-logs` | Follow the application log |
| `dev-logs-db` | Follow the database log |
Once running:
| Service | URL |
|---------|-----|
| App | http://localhost:8000 |
| Vite | http://localhost:5173 |
| MySQL | localhost:3307 |
Without Nix, start the same containers directly from
`docker/dev/docker-compose.yml`. Contributions improving the setup instructions
for other platforms are welcome.
## Before opening a pull request
Three checks run in CI, and all three must pass. Run them locally first, from
inside the app container or anywhere the project's dependencies are available:
```bash
vendor/bin/pint --test # code style, Laravel preset
vendor/bin/phpstan analyse # static analysis, level 7
php artisan test # PHPUnit, Feature suite
```
Some conventions:
- **Static analysis.** PHPStan runs at level 7 with no baseline, and the project
is clean at that level. Keep it that way rather than introducing one. Inline
`@phpstan-ignore` comments aren't used either.
- **Tests.** New behaviour needs a test. Tests run against sqlite in memory and
must work offline, so use factories or fixtures rather than reaching for the
network or a real database.
- **Dependencies.** `composer.lock` and `package-lock.json` are both committed.
If you change dependencies, commit the updated lockfile alongside.
## Commits
One commit does one thing. Keep each commit passing all three checks so history
stays bisectable. Separate renames from behaviour changes, and mechanical edits
from logic.
Commit messages are a single line, referencing the issue they belong to:
```
52 - Replace React/Inertia with Blade + Livewire 4
```
No body, no trailers.
## License
By contributing, you agree that your contributions are licensed under the
[GNU AGPL-3.0](LICENSE), the same license as the project.

143
LICENSE
View file

@ -1,5 +1,5 @@
GNU GENERAL PUBLIC LICENSE
Version 3, 29 June 2007
GNU AFFERO GENERAL PUBLIC LICENSE
Version 3, 19 November 2007
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
Everyone is permitted to copy and distribute verbatim copies
@ -7,17 +7,15 @@
Preamble
The GNU General Public License is a free, copyleft license for
software and other kinds of works.
The GNU Affero General Public License is a free, copyleft license for
software and other kinds of works, specifically designed to ensure
cooperation with the community in the case of network server software.
The licenses for most software and other practical works are designed
to take away your freedom to share and change the works. By contrast,
the GNU General Public License is intended to guarantee your freedom to
our General Public Licenses are intended to guarantee your freedom to
share and change all versions of a program--to make sure it remains free
software for all its users. We, the Free Software Foundation, use the
GNU General Public License for most of our software; it applies also to
any other work released this way by its authors. You can apply it to
your programs, too.
software for all its users.
When we speak of free software, we are referring to freedom, not
price. Our General Public Licenses are designed to make sure that you
@ -26,44 +24,34 @@ them if you wish), that you receive source code or can get it if you
want it, that you can change the software or use pieces of it in new
free programs, and that you know you can do these things.
To protect your rights, we need to prevent others from denying you
these rights or asking you to surrender the rights. Therefore, you have
certain responsibilities if you distribute copies of the software, or if
you modify it: responsibilities to respect the freedom of others.
Developers that use our General Public Licenses protect your rights
with two steps: (1) assert copyright on the software, and (2) offer
you this License which gives you legal permission to copy, distribute
and/or modify the software.
For example, if you distribute copies of such a program, whether
gratis or for a fee, you must pass on to the recipients the same
freedoms that you received. You must make sure that they, too, receive
or can get the source code. And you must show them these terms so they
know their rights.
A secondary benefit of defending all users' freedom is that
improvements made in alternate versions of the program, if they
receive widespread use, become available for other developers to
incorporate. Many developers of free software are heartened and
encouraged by the resulting cooperation. However, in the case of
software used on network servers, this result may fail to come about.
The GNU General Public License permits making a modified version and
letting the public access it on a server without ever releasing its
source code to the public.
Developers that use the GNU GPL protect your rights with two steps:
(1) assert copyright on the software, and (2) offer you this License
giving you legal permission to copy, distribute and/or modify it.
The GNU Affero General Public License is designed specifically to
ensure that, in such cases, the modified source code becomes available
to the community. It requires the operator of a network server to
provide the source code of the modified version running there to the
users of that server. Therefore, public use of a modified version, on
a publicly accessible server, gives the public access to the source
code of the modified version.
For the developers' and authors' protection, the GPL clearly explains
that there is no warranty for this free software. For both users' and
authors' sake, the GPL requires that modified versions be marked as
changed, so that their problems will not be attributed erroneously to
authors of previous versions.
Some devices are designed to deny users access to install or run
modified versions of the software inside them, although the manufacturer
can do so. This is fundamentally incompatible with the aim of
protecting users' freedom to change the software. The systematic
pattern of such abuse occurs in the area of products for individuals to
use, which is precisely where it is most unacceptable. Therefore, we
have designed this version of the GPL to prohibit the practice for those
products. If such problems arise substantially in other domains, we
stand ready to extend this provision to those domains in future versions
of the GPL, as needed to protect the freedom of users.
Finally, every program is threatened constantly by software patents.
States should not allow patents to restrict development and use of
software on general-purpose computers, but in those that do, we wish to
avoid the special danger that patents applied to a free program could
make it effectively proprietary. To prevent this, the GPL assures that
patents cannot be used to render the program non-free.
An older license, called the Affero General Public License and
published by Affero, was designed to accomplish similar goals. This is
a different license, not a version of the Affero GPL, but Affero has
released a new version of the Affero GPL which permits relicensing under
this license.
The precise terms and conditions for copying, distribution and
modification follow.
@ -72,7 +60,7 @@ modification follow.
0. Definitions.
"This License" refers to version 3 of the GNU General Public License.
"This License" refers to version 3 of the GNU Affero General Public License.
"Copyright" also means copyright-like laws that apply to other kinds of
works, such as semiconductor masks.
@ -549,35 +537,45 @@ to collect a royalty for further conveying from those to whom you convey
the Program, the only way you could satisfy both those terms and this
License would be to refrain entirely from conveying the Program.
13. Use with the GNU Affero General Public License.
13. Remote Network Interaction; Use with the GNU General Public License.
Notwithstanding any other provision of this License, if you modify the
Program, your modified version must prominently offer all users
interacting with it remotely through a computer network (if your version
supports such interaction) an opportunity to receive the Corresponding
Source of your version by providing access to the Corresponding Source
from a network server at no charge, through some standard or customary
means of facilitating copying of software. This Corresponding Source
shall include the Corresponding Source for any work covered by version 3
of the GNU General Public License that is incorporated pursuant to the
following paragraph.
Notwithstanding any other provision of this License, you have
permission to link or combine any covered work with a work licensed
under version 3 of the GNU Affero General Public License into a single
under version 3 of the GNU General Public License into a single
combined work, and to convey the resulting work. The terms of this
License will continue to apply to the part which is the covered work,
but the special requirements of the GNU Affero General Public License,
section 13, concerning interaction through a network will apply to the
combination as such.
but the work with which it is combined will remain governed by version
3 of the GNU General Public License.
14. Revised Versions of this License.
The Free Software Foundation may publish revised and/or new versions of
the GNU General Public License from time to time. Such new versions will
be similar in spirit to the present version, but may differ in detail to
the GNU Affero General Public License from time to time. Such new versions
will be similar in spirit to the present version, but may differ in detail to
address new problems or concerns.
Each version is given a distinguishing version number. If the
Program specifies that a certain numbered version of the GNU General
Program specifies that a certain numbered version of the GNU Affero General
Public License "or any later version" applies to it, you have the
option of following the terms and conditions either of that numbered
version or of any later version published by the Free Software
Foundation. If the Program does not specify a version number of the
GNU General Public License, you may choose any version ever published
GNU Affero General Public License, you may choose any version ever published
by the Free Software Foundation.
If the Program specifies that a proxy can decide which future
versions of the GNU General Public License can be used, that proxy's
versions of the GNU Affero General Public License can be used, that proxy's
public statement of acceptance of a version permanently authorizes you
to choose that version for the Program.
@ -635,40 +633,29 @@ the "copyright" line and a pointer to where the full notice is found.
Copyright (C) <year> <name of author>
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
it under the terms of the GNU Affero General Public License as published
by the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
GNU Affero General Public License for more details.
You should have received a copy of the GNU General Public License
You should have received a copy of the GNU Affero General Public License
along with this program. If not, see <https://www.gnu.org/licenses/>.
Also add information on how to contact you by electronic and paper mail.
If the program does terminal interaction, make it output a short
notice like this when it starts in an interactive mode:
<program> Copyright (C) <year> <name of author>
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
This is free software, and you are welcome to redistribute it
under certain conditions; type `show c' for details.
The hypothetical commands `show w' and `show c' should show the appropriate
parts of the General Public License. Of course, your program's commands
might be different; for a GUI interface, you would use an "about box".
If your software can interact with users remotely through a computer
network, you should also make sure that it provides a way for users to
get its source. For example, if your program is a web application, its
interface could display a "Source" link that leads users to an archive
of the code. There are many ways you could offer source, and different
solutions will be better for different programs; see section 13 for the
specific requirements.
You should also get your employer (if you work as a programmer) or school,
if any, to sign a "copyright disclaimer" for the program, if necessary.
For more information on this, and how to apply and follow the GNU GPL, see
For more information on this, and how to apply and follow the GNU AGPL, see
<https://www.gnu.org/licenses/>.
The GNU General Public License does not permit incorporating your program
into proprietary programs. If your program is a subroutine library, you
may consider it more useful to permit linking proprietary applications with
the library. If this is what you want to do, use the GNU Lesser General
Public License instead of this License. But first, please read
<https://www.gnu.org/licenses/why-not-lgpl.html>.

18
README.md
View file

@ -6,7 +6,7 @@ # incr
*Track anything you accumulate — click to increment*
[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)
[![License: AGPL v3](https://img.shields.io/badge/License-AGPLv3-blue.svg)](https://www.gnu.org/licenses/agpl-3.0)
[![Laravel](https://img.shields.io/badge/Laravel-13-FF2D20?logo=laravel&logoColor=white)](https://laravel.com/)
[![Livewire](https://img.shields.io/badge/Livewire-4-FB70A9?logo=livewire&logoColor=white)](https://livewire.laravel.com/)
@ -18,6 +18,16 @@ ## About
It features a distinctive LED-style digital display and nothing else.
## Screenshots
![The counter](docs/screenshots/counter.png)
The whole application. Click the number to add one.
![Setting a value](docs/screenshots/set-value.png)
The dialog, for when clicking once at a time is not practical.
## Features
- **LED-style display** — large red digital counter
@ -104,6 +114,10 @@ ## Development
The dev stack binds host ports 8000, 5173 and 3307. Only one project using these can run at a time.
## Contributing
See [CONTRIBUTING.md](CONTRIBUTING.md).
## License
GNU General Public License v3.0 — see [LICENSE](LICENSE).
incr is free software, licensed under the [GNU AGPL-3.0](LICENSE).

2
composer.json
View file

@ -7,7 +7,7 @@
"laravel",
"framework"
],
"license": "MIT",
"license": "AGPL-3.0-only",
"require": {
"php": "^8.2",
"laravel/framework": "^13.0",

0
docs/screenshots/.gitkeep Normal file
View file