Skip to content
View timezyme's full-sized avatar

Block or report timezyme

Block user

Prevent this user from interacting with your repositories and sending you notifications. Learn more about blocking users.

You must be logged in to block users.

Please don't include any personal information such as legal names or email addresses. Maximum 100 characters, markdown supported. This note will be visible to only you.
Report abuse

Contact GitHub support about this user’s behavior. Learn more about reporting abuse.

Report abuse
timezyme/README.md

TimeZyme: Illuminating Knowledge, Connecting Insights

TimeZyme transforms dense documents into interactive, layered knowledge maps called Zymes. Built with Nuxt 4, this platform enables professionals to understand complex material faster and discover connections across their knowledge ecosystem.

πŸš€ Overview

TimeZyme is a graph-native knowledge platform that revolutionizes how professionals interact with complex documentsβ€”legal opinions, research papers, financial reports, and more. By converting static documents into dynamic, interconnected Zymes, users can:

  • Understand Faster: Grasp key takeaways in minutes, not hours (e.g., 47-min legal opinion β†’ 12-min Zyme)
  • Explore Flexibly: Navigate through progressive layers (L0 Abstract β†’ L1 Bullets β†’ L2 Summary β†’ L3 Source)
  • Connect Instantly: Discover relationships between documents, concepts, and entities without breaking flow

πŸ—οΈ Architecture

Built on a modern tech stack leveraging Nuxt 4's modular layer system:

Core Technologies

  • Framework: Nuxt 4 with Vue 3
  • UI: Nuxt UI Pro with TailwindCSS 4
  • Database: SQLite with Drizzle ORM (via NuxtHub)
  • Authentication: OAuth (GitHub, Google) and password auth
  • Payments: Polar integration for subscriptions
  • Deployment: NuxtHub (Cloudflare Workers)

Modular Layers

  • core: Common components and utilities
  • auth: Authentication system with session management
  • dashboard: User and admin dashboards
  • payment: Subscription and billing management
  • docs: Documentation system
  • blog: Content management
  • waitlist: Early access system

πŸš€ Quick Start

Prerequisites

  • Node.js 22+
  • pnpm package manager

Setup

# Clone the repository
git clone https://github.com/timezyme/timezyme.git
cd timezyme

# Install dependencies
pnpm install

# Set up environment variables
cp .env.example .env
# Edit .env with your configuration

# Start development server
pnpm dev

The app will be available at http://localhost:9009

Demo Accounts

After seeding the database:

πŸ§ͺ Development

Essential Commands

pnpm dev              # Start dev server on port 9009
pnpm build            # Build for production
pnpm preview          # Preview production build
pnpm typecheck        # Run TypeScript checks
pnpm lint             # Run ESLint
pnpm test:e2e         # Run Playwright tests

Testing

Always run tests after making changes:

./scripts/post-task-verify.sh        # Quick verification
./scripts/post-task-verify.sh --full # Full test suite

Database

pnpm db:generate      # Generate database migrations
./scripts/db-reset.sh # Reset database (with confirmation)
./scripts/db-seed.sh  # Seed with demo data

πŸš€ Deployment

Deploy to NuxtHub (Cloudflare):

pnpm deploy

The GitHub Actions workflow automatically deploys on push to main branch.

πŸ” Environment Variables

Key environment variables (see validate-env.ts for full list):

  • NUXT_SESSION_PASSWORD: 32+ character session secret
  • NUXT_PUBLIC_BASE_URL: Your app URL
  • OAuth: NUXT_OAUTH_GITHUB_*, NUXT_OAUTH_GOOGLE_*
  • Payments: NUXT_PRIVATE_POLAR_* (use sandbox for dev)
  • Email: NUXT_PRIVATE_EMAIL_* (Resend)

πŸ“š Documentation

🀝 Contributing

See CLAUDE.md for development guidelines and important notes about working with this codebase.

⚠️ Important Notes

  • This project uses Nuxt 4, not Nuxt 3
  • Always run tests before considering any task complete
  • Never delete the .data directory without backing up first
  • Use Scrypt for password hashing (not bcrypt)

πŸ“ License

Β© 2024 TimeZyme. All rights reserved.

Popular repositories Loading

  1. timezyme-nuxt timezyme-nuxt Public

    Vue

  2. nuxtstarterkit nuxtstarterkit Public

    Vue

  3. timezyme timezyme Public

    Vue