@5daysprint/framework

The official NPM package for the 5 Day Sprint Framework - automated project scaffolding with AI integration.

Installation

npm install -g @5daysprint/framework

Usage

CLI Usage

npx @5daysprint/framework <user-uuid> <project-uuid>

Example:

npx @5daysprint/framework ea5973ff-489c-4d88-aa04-e50fd231e44c 4fe8f5b5-401c-4f19-a310-d2db47606ec5

Options

• --endpoint <url> - Custom API endpoint (default: https://5daysprint.com)
• --verbose - Enable verbose output
• --dry-run - Show what would be done without executing
• --help - Show help information

Programmatic Usage

import { executeFramework } from '@5daysprint/framework';

await executeFramework(userUuid, projectUuid, {
  verbose: true,
  dryRun: false
});

Features

• 🚀 Automated Setup - Complete project scaffolding in seconds
• 🔒 Secure - Validates user subscription and project ownership
• 📊 Progress Tracking - Real-time feedback during execution
• 🎯 Framework Integration - Uses the full 5 Day Sprint methodology
• 🛠️ Configurable - Support for custom endpoints and options

What It Does

The framework automatically:

1. Validates Access - Ensures you have subscriber access and project ownership
2. Fetches Configuration - Downloads your personalized project setup
3. Creates Structure - Scaffolds Next.js 14 project with TypeScript
4. Installs Dependencies - Adds Supabase, Shadcn/UI, and essential packages
5. Configures Environment - Sets up environment files and configuration
6. Applies Framework - Implements the complete 5 Day Sprint methodology

Prerequisites

• Node.js 14 or higher
• npm or yarn
• Valid 5 Day Sprint subscription
• Project created on 5daysprint.com

Security

• All API calls are authenticated
• Projects are validated against user ownership
• Subscriber status is verified before execution
• No sensitive data is logged or stored

Support

• 📖 Documentation: 5daysprint.com/docs
• 💬 Support: 5daysprint.com/support
• 🐛 Issues: GitHub Issues

License

MIT © 5 Day Sprint

Built with ❤️ by the 5 Day Sprint team