Working Document
This is a working document, please note items within this will change over the course of time.
The following features/tests/documentation will need to be completed before we start working on 0.32.
Task Completed
Story points will be implemented on the following objects;
Relevant tickets:
Currently the new GDPR Wizard and API are hidden functionality within NearBeach. We're initially rolling them out to Power Users to gather feedback before making them available to everyone.
The API requires an admin portal to be created, so the users will be able to add and remove API keys. We are currently discussing where this portal should belong. aka on the user profile or within it's own section.
The GDPR wizard will need to be added to the administration menu.
Relevant Tickets:
Currently we are requesting feedback on the following items;
Over the next few months this feedback will shape and guide how these new functions operate within NearBeach.
Relevant Tickets:
For us to have confidence that we will not break NearBeach when we start development of the 0.32 branch, we will need a lot of Unit Tests. Our main focus on the unit tests will be;
Relevant Tickets:
One of our core issues at the moment, is NearBeach is lacking documentation. Especially for any of the new functionality we have implemented within the 0.31 branch.
First Stage Completed
We are currently utilising Swagger to document all API calls. This requires us to document all that information at the code level. We'll then get a Git Action to compile that documentation and host it on Azure. Currently the location of the swagger documentation will be - https://swagger.nearbeach.org/
Over the next few weeks, we will be finalising this setup.
Relevant Tickets:
We'll be looking at documenting all of NearBeach, both the old functionality and the newly created. Other documentation will include procedures like implementing a test workflow for any docker changes, i.e. when a new library is implemented in NearBeach.
The following objectives will need to be completed before we will start the new branch.
We are hoping to get NearBeach 0.31 to a stable point, where we just need to release library updates as we develop 0.32.
We will still be supporting the 0.31 branch during the 0.32 development. Any bugs brought up in this time will be looked at, and dealt with. The support for the 0.31 branch will occur until the release of the version 0.32.0. At that time, we will request everyone to upgrade to the latest version.
During the development of 0.32, we will be doing weekly releases to make sure all the libraries are updated.
Please note - the time-frames mentioned here are estimates and may shift during development. Though we try our hardest to make conservative guesses at how long a task takes, that task will always take longer. We are trying our hardest not to replicate Valve Time - https://developer.valvesoftware.com/wiki/Valve_Time
We are currently aiming to wrap up the 0.31 branch in early September 2025. Most of the remaining work focuses on documentation and improving existing services, rather than introducing new functionality.
At the start of September we are hoping to create the 0.32 branch, in which we will start development. We expect this development to take around 7 months to complete.
| Stage | Approximate Date Started | Approximate Date Finished |
| Story Point Feature | 1st June 2025 | 7th June 2025 |
| 0.31 Branch Wrap Up | 7th July 2025 | 1st September 2025 |
| 0.32 Development Start Up | 1st September 2025 | 1st April 2026 |
| 0.32.0 Release | 1st April 2026 |
Our main focus on the 0.32 branch
During the development of the 0.32 branch, we'll be focusing on the following items;