Skip to content

About

Enterprise-grade personal intentions & focus engine with kinetic motion architecture and local-first data resilience

Resources

Stars

1 star

Watchers

0 watching

Forks

Repository files navigation

Never Forget Banner

Enterprise-Grade Intentions & Focus Engine
Mindful task orchestration with kinetic motion architecture, authoritative server validation, and local-first data resilience.

Nuxt 4 Vue 3 TypeScript SQLite Capacitor Node 24+ Tests License


Executive Summary

Never Forget is a high-reliability, distraction-free productivity engine engineered for mindful task capture, proactive time management, and cognitive relief. Architected around a Local-First / Server-Authoritative paradigm, Never Forget combines a fluid aesthetic canvas with strict schema guarantees, zero external telemetry leaks, and cross-platform native readiness across Web, PWA, and Android.


Key Architectural Highlights

NEVER FORGET ARCHITECTURE
┌─────────────────────────────────────────────────────────────────┐
│                     Client Experience Layer                     │
│  [ Celestial Canvas ]   [ Clockwork Astrolabe ]   [ Constellations ]│
│  [ Notebook Pencil Canvas with Typewriter & Screensaver Drift ] │
└───────────────────────────────┬─────────────────────────────────┘
                                │
        ┌───────────────────────┴───────────────────────┐
        ▼                                               ▼
┌───────────────────────────────┐   ┌─────────────────────────────┐
│    Static PWA / Android Native│   │     Enterprise Nuxt Server  │
│  - Capacitor Preferences      │   │  - Nitro HTTP Engine        │
│  - Scheduled Local Alarms     │   │  - Authoritative Zod Guard  │
│  - Offline Autonomous Store   │   │  - SQLite Engine (WAL mode) │
└───────────────────────────────┘   └─────────────────────────────┘
  • Modular Domain Partitioning: Divide-and-rule architecture isolating Background Canvases, Goal Management, Modal Overlays, and Kinematic Gesture Navigation into self-contained sub-modules.
  • Kinematic Motion System: Organic mathematical physics engine featuring fluid mouse parallax tracking, live typewriter equation drawing, and screensaver drift with guaranteed non-overlapping sector shuffling.
  • Authoritative Validation: All mutations pass through strict Zod schemas enforced server-side before persisting into transactional SQLite storage.
  • Privacy & Data Sovereign: Zero analytics tracking, no external ad SDKs, and local-first data isolation.

Capabilities & Feature Matrix

Feature Specification User Benefit
Instant Intention Capture Curated psychological triggers & custom text Seamlessly offload mental cache in under 2 seconds.
Proactive Scheduling +10 Min, Tonight at 8:00 PM, Custom Datetime Contextual reminder workflows with one-touch triggers.
Artistic Multi-Canvas FX Celestial Sky, Clockwork Orbit, Constellation, Notebook Focus-enhancing ambient aesthetics with zero cognitive fatigue.
Multi-Theme Engine 4 Light (Parchment, Terracotta, Sage, Amber) + 4 Dark (Indigo, Obsidian, Emerald, Plum) Engineered contrast and typography optimized for day/night focus.
Fail-Safe Undo & Edit In-place undo toast & instant inline modification Eliminates accidental completions without disruptive confirm modals.
Cross-Platform Delivery Browser Web, Progressive Web App, Native Android (APK) Universal availability across mobile and desktop workstations.

Quick Start Guide

Prerequisites

  • Node.js: v24.0.0 or higher
  • Package Manager: npm (v10+)

1. Installation

Clone the repository and install project dependencies:

git clone https://github.com/dr-week/neverforget.git
cd neverforget
npm install

2. Development Server

Launch the development instance with hot module replacement:

npm run dev

Navigate to http://127.0.0.1:3000. The backend auto-initializes the transactional database at .data/neverforget.sqlite upon boot.

3. Production Deployment

To compile and produce optimized client/server bundles:

# Typecheck TypeScript codebase
npm run typecheck

# Run test suite
npm test

# Generate production Nitro server
npm run build

# Preview production build locally
npm run preview

Environment & Configuration

Variable Default Value Description
DATABASE_PATH .data/neverforget.sqlite Filepath for the SQLite relational store.
NEVERFORGET_MOBILE 0 Disables SSR and toggles local Preferences adapter for static builds.
PORT 3000 HTTP port for the Nitro application server.
TEST_URL http://127.0.0.1:3100 Endpoint target for integration and smoke test runs.

Multi-Platform Builds

Static Web & PWA

Generate a standalone static application bundle in .output/public:

npm run web:static

Android Native Build

Synchronize native assets and build via Capacitor:

# Sync web artifacts with native Android wrapper
npm run android:sync

# Compile debug Android APK
npm run android:apk

Output APK will be located under android/app/build/outputs/apk/debug/app-debug.apk.


Project Structure & Architecture

NEVERFORGET/
├── app/
│   ├── components/
│   │   ├── backgrounds/       # Kinematic canvas layers (Celestial, Clockwork, Notebook)
│   │   ├── controls/          # Floating action bar & gesture controllers
│   │   ├── goals/             # Form, card list, header greetings, & edit modals
│   │   └── overlays/          # Settings drawers, journal modals, calming banner
│   ├── composables/           # Business logic (useIntentions, useThemeSettings, useMotion)
│   └── app.vue                # Lean root application orchestrator
├── server/
│   ├── api/                   # Nitro REST route handlers (/api/goals, /api/insights)
│   ├── middleware/            # CSRF origin security verification
│   └── utils/                 # Database initialization & Zod schema validation
├── shared/                    # Cross-environment types, contracts, & state machines
├── tests/                     # Unit test suites and smoke integration checks
└── docs/                      # Technical specifications and maintenance guides

Comprehensive Documentation

For deep technical dives, refer to our comprehensive documentation library:


Verification & Quality Assurance

Never Forget enforces rigorous automated verification standards across all code changes:

npm run typecheck    # Strict TypeScript contract validation
npm test             # Core logic & state transition test runner
npm run build        # Production bundle synthesis & tree-shaking verification

License

This project is distributed under the MIT License. See LICENSE for details.


Crafted with care and precision by the Never Forget Engineering Team.

About

Enterprise-grade personal intentions & focus engine with kinetic motion architecture and local-first data resilience

Resources

Stars

1 star

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages