Skip to content

Study Buddy v0.1.0-alpha.1

Pre-release
Pre-release

Choose a tag to compare

@github-actions github-actions released this 20 Aug 18:24
4f1eeab

Study Buddy v0.1.0-alpha.1

This is the first controlled Study Buddy alpha candidate. It is intended for
technical evaluation with synthetic data and explicitly authorized student
accounts. Breaking changes remain possible.

Highlights

  • Local-first, source-grounded Moodle and FH Technikum workflows.
  • Validated PDF study guides and single-file offline learning pages.
  • Fast, Balanced, and Quality execution profiles in the desktop interface.
  • Isolated Quick Chat workspaces and deliverables for concurrent conversations.
  • Conservative quiz and assignment boundaries; final Moodle quiz submission is
    blocked.
  • Cross-platform automated verification, dependency auditing, secret scanning,
    CodeQL, license policy, checksums, and CycloneDX SBOM evidence.

Known limitations

  • This is an alpha, not a stable or supported production release.
  • FH Technikum CIS/calendar integration is institution-specific. Other student
    portals are not generically supported.
  • Production analytics remain disabled by default and are outside the supported
    alpha contract.
  • The initial desktop binary matrix is Linux x64 and Windows x64. macOS binaries
    are deferred and are not supported by this alpha.
  • The Windows installer is intentionally unsigned. Windows SmartScreen or
    managed-device policy may warn about or block it; a trusted Authenticode
    signature is planned only after the project qualifies for an appropriate
    signing program.
  • Only platforms explicitly listed with a manually verified artifact in the
    final GitHub release are claimed as supported.
  • Users remain responsible for portal terms, academic-integrity rules, and the
    redistribution rights of course material and generated artifacts.

Install and verify

Download files only from this GitHub release. Compare the selected binary's
SHA-256 value with the attached SHA256SUMS before launching it.

On Windows PowerShell:

Get-FileHash .\Study-Buddy-0.1.0-alpha.1-x64.exe -Algorithm SHA256

An Unknown publisher or Windows SmartScreen warning is expected for this
unsigned Alpha. After verifying the checksum and release URL, a user who elects
to continue can use the warning dialog's per-file override. Do not disable
SmartScreen globally. If device policy blocks the installer, do not circumvent
that policy. Uninstall through Settings → Apps → Installed apps → Study
Buddy
.

On Linux:

sha256sum Study-Buddy-0.1.0-alpha.1-x86_64.AppImage
chmod u+x Study-Buddy-0.1.0-alpha.1-x86_64.AppImage
./Study-Buddy-0.1.0-alpha.1-x86_64.AppImage

Close Study Buddy and remove the AppImage to uninstall the executable. Local
application state is retained separately so it is not deleted accidentally.

Source installation

GitHub-generated source archives omit submodule contents. Clone recursively:

git clone --recurse-submodules https://github.com/HabsaTheDog/StudyBuddy.git
cd StudyBuddy
npm ci

Read README.md, SECURITY.md, and PRIVACY.md before connecting an account.
Verify binary downloads with the attached SHA256SUMS; the release bundle also
contains the exact root/interface commit manifest and production SBOM.