Jump to content

RefractTrack Home: Difference between revisions

From Pixel Refraction Studio
← Older editNewer edit →

Nerdofepic (talk | contribs)

3 user groups
199 edits
m Nerdofepic moved page RefractTrack to RefractTrack Home: This is the home page for the refracttrack documentation collection. Title now reflects that.
No edit summary
Line 1: Line 1:
=RefractTrack=
== RefractTrack Documentation ==
Self-Hosted Indie Game Development Task Tracker


=Highlights=
RefractTrack is a small, self-hosted kanban tool for tracking development tasks across one or more game projects. It runs on plain PHP 8 and MySQL/MariaDB with no framework and no build step, uses Jira-style task IDs (<code><nowiki>PREFIX-123</nowiki></code>) with matching clean URLs (<code><nowiki>/task/FE-12</nowiki></code>), and supports fine-grained role-based permissions, per-project stages/groups/saved lists, CSV/JSON export and import, 15 selectable color themes, and automatic schema migrations.
; One Time Purchase - [https://nerdofepic.itch.io/refracttrack Buy It!]
: Inexpensive solution for keeping track of your indie game project. There are no subscription fees or per-seat fees. Check out the [[RefractTrack Cost Breakdown]].


; Self-Hosted
This documentation describes RefractTrack as of package version '''v99'''.
: Set it up and use it on your own server. No more worrying about cloud providers going away. There is even a pre-assembled image for rapid deployment on a Raspberry Pi.


; Indie Game Development
=== Getting started ===
: Supports your development team with powerful features and has an easy way for play testers to report bugs or share feature ideas too.
* [https://nerdofepic.itch.io/refracttrack Buy It!] - For sale at itch.io
* [[RefractTrack_Installation|Installation]] — guided wizard and manual setup, requirements, upgrading an existing install
* [[RefractTrack_Server_Setup|Server Setup]] — the standalone <code><nowiki>prereqs.sh</nowiki></code> provisioning script for a fresh Debian/Ubuntu box
* [[RefractTrack_Configuration|Configuration]] — <code><nowiki>config/config.php</nowiki></code> settings and Clean URLs


; Loads of Features
=== Core concepts ===
: As I designed it I added features that helped me. Now it does a ton of things. Check out the [[RefractTrack Features]].
 
* [[RefractTrack_Projects|Projects]] — multi-project support, task numbering, soft delete
* [[RefractTrack_Tasks|Tasks]] — task fields, task types, bug-specific fields, task codes
* [[RefractTrack_Board_and_List_Views|Board and List Views]] — the kanban board, drag-and-drop, list/filter view
* [[RefractTrack_Stages|Stages]] — per-project swimlanes/workflow stages
* [[RefractTrack_Groups|Groups]] — per-project many-to-many task tags
* [[RefractTrack_Markdown_Formatting|Markdown Formatting]] — the supported text-formatting subset and task-code auto-linking
 
=== Workflows ===
 
* [[RefractTrack_Bulk_Task_Creation_and_Saved_Lists|Bulk Task Creation and Saved Lists]] — mail-merge style batch task creation
* [[RefractTrack_Archiving|Archiving]] — archiving/unarchiving tasks individually or in bulk
* [[RefractTrack_Approvals_and_Review|Approvals and Review]] — the task review workflow (pending / approved / won't do)
* [[RefractTrack_Comments_and_Activity_Log|Comments and Activity Log]] — discussion and automatic system history on each task
* [[RefractTrack_Attachments|Attachments]] — file uploads on tasks
* [[RefractTrack_Export_and_Import|Export and Import]] — CSV/JSON project export and import
 
=== Administration ===
 
* [[RefractTrack_Users|Users]] — accounts, activation, password resets
* [[RefractTrack_Permissions_and_Roles|Permissions and Roles]] — the full RBAC model, role presets, per-user overrides
* [[RefractTrack_Themes_and_Branding|Themes and Branding]] — the 15 color themes and application name
* [[RefractTrack_Per_User_Preferences|Per User Preferences]] — what the app remembers per user across sessions
* [[RefractTrack_Migrations_and_Upgrades|Migrations and Upgrades]] — automatic schema migrations, web and CLI upgrade paths
 
=== Reference ===
 
* [[RefractTrack_Feature_Inventory|Feature Inventory]] — a flat checklist of everything the app can do
* [[RefractTrack_Data_Model|Data Model]] — database tables at a glance
* [[RefractTrack_Security|Security]] — the hardening measures built into the app
* [[RefractTrack_Architecture|Architecture]] — request lifecycle and where things live in the codebase (for maintainers)
* [[RefractTrack_Known_Limitations|Known Limitations]] — things that are deliberately not supported yet

Revision as of 23:08, 27 August 2026

RefractTrack Documentation

RefractTrack is a small, self-hosted kanban tool for tracking development tasks across one or more game projects. It runs on plain PHP 8 and MySQL/MariaDB with no framework and no build step, uses Jira-style task IDs (PREFIX-123) with matching clean URLs (/task/FE-12), and supports fine-grained role-based permissions, per-project stages/groups/saved lists, CSV/JSON export and import, 15 selectable color themes, and automatic schema migrations.

This documentation describes RefractTrack as of package version v99.

Getting started

  • Buy It! - For sale at itch.io
  • Installation — guided wizard and manual setup, requirements, upgrading an existing install
  • Server Setup — the standalone prereqs.sh provisioning script for a fresh Debian/Ubuntu box
  • Configuration — config/config.php settings and Clean URLs

Core concepts

  • Projects — multi-project support, task numbering, soft delete
  • Tasks — task fields, task types, bug-specific fields, task codes
  • Board and List Views — the kanban board, drag-and-drop, list/filter view
  • Stages — per-project swimlanes/workflow stages
  • Groups — per-project many-to-many task tags
  • Markdown Formatting — the supported text-formatting subset and task-code auto-linking

Workflows

Administration

Reference

  • Feature Inventory — a flat checklist of everything the app can do
  • Data Model — database tables at a glance
  • Security — the hardening measures built into the app
  • Architecture — request lifecycle and where things live in the codebase (for maintainers)
  • Known Limitations — things that are deliberately not supported yet
Retrieved from "https://wiki.pixelrefraction.com/index.php?title=RefractTrack_Home&oldid=14"