Skip to content

Latest commit

 

History

History
305 lines (213 loc) · 9.24 KB

README.md

File metadata and controls

305 lines (213 loc) · 9.24 KB
LogicStamp

The official landing page and documentation site for LogicStamp

Next.js TypeScript Tailwind CSS License

Website • Documentation • MCP Integration • GitHub • Contributing

LogicStamp Context strict watch generates context bundles that MCP-powered assistants use

Example workflow: `stamp context --strict-watch` generates context bundles that MCP-powered assistants use to explain component architecture (ThemeContext shown here).

About

This is the official landing page and documentation website for LogicStamp - the Context Compiler for TypeScript.

LogicStamp compiles TypeScript codebases into deterministic architectural contracts and dependency graphs, providing a structured, auditable source of truth for AI coding workflows and modern development tooling.

LogicStamp MCP enables AI assistants (Claude, Cursor, etc.) to analyze TypeScript codebases through the Model Context Protocol, providing structured component contracts, dependency graphs, and style metadata.

The site is built with Next.js 16, TypeScript, and Tailwind CSS, featuring a modern, responsive design with dark mode support.

Features

  • Next.js 16 with App Router for optimal performance
  • TypeScript for type-safe development
  • Tailwind CSS for modern, responsive styling
  • Dark Mode support with smooth theme transitions
  • Fully Responsive design for all devices
  • Fast Performance with optimized builds
  • Comprehensive Testing with Vitest and React Testing Library
  • Documentation integrated directly into the site
  • SEO Optimized for better discoverability

Quick Start

Prerequisites

  • Node.js >= 20.9.0
  • npm, yarn, or pnpm package manager

Installation

  1. Clone the repository:
git clone https://github.com/LogicStamp/logicstamp.dev.git
cd logicstamp.dev
  1. Install dependencies:
npm install
# or
yarn install
# or
pnpm install
  1. Set up environment variables (if needed):

Create a .env.local file in the root directory:

NEXT_PUBLIC_SITE_URL=http://localhost:3000

Using LogicStamp CLI

Generate context bundles for your project:

# Generate context bundles
stamp context

# Generate with style metadata
stamp context style

Common commands:

  • stamp context - Generate context bundles
  • stamp context style - Generate with style metadata (Tailwind, SCSS, etc.)

For more information, see the LogicStamp CLI documentation.

Using LogicStamp MCP

LogicStamp MCP enables AI assistants to analyze your codebase through the Model Context Protocol:

  • Claude Desktop - Integrate LogicStamp with Claude Desktop
  • Cursor IDE - Use LogicStamp directly in Cursor
  • Claude CLI - Command-line integration for Claude Code

The MCP server provides structured context bundles optimized for AI consumption, including component contracts, dependency graphs, and optional style metadata.

Quick Start:

Development

Start the development server:

npm run dev
# or
yarn dev
# or
pnpm dev

Open http://localhost:3000 in your browser to see the result.

The page auto-updates as you edit files. The src/app directory is where most of your edits happen.

Build

Build the application for production:

npm run build

This creates an optimized production build in the .next folder.

Production

Start the production server:

npm start

Testing

Run the test suite:

# Run tests in watch mode
npm test

# Run tests with UI
npm run test:ui

# Run tests once
npm run test:run

# Run tests with coverage
npm run test:coverage

Type Checking

Verify TypeScript types:

npm run type-check

Linting

Check code quality:

npm run lint

Project Structure

logicstamp.dev/
├── src/
│   ├── app/                    # Next.js App Router pages and routes
│   │   ├── api/                # API routes
│   │   ├── demo/               # Demo page
│   │   ├── docs/               # Documentation pages
│   │   │   ├── getting-started/
│   │   │   ├── guides/
│   │   │   ├── logicstamp-context/
│   │   │   └── ...
│   │   ├── layout.tsx          # Root layout
│   │   └── page.tsx            # Home page
│   ├── components/             # React components
│   │   ├── sections/           # Page sections (Hero, Features, FAQ, etc.)
│   │   ├── ui/                 # Reusable UI components
│   │   └── ...
│   ├── contexts/               # React contexts (Theme, etc.)
│   ├── hooks/                  # Custom React hooks
│   └── styles/                 # Global styles and themes
├── __tests__/                  # Test files
├── docs/                       # Documentation source files
├── public/                     # Static assets
├── next.config.js              # Next.js configuration
├── tailwind.config.ts          # Tailwind CSS configuration
├── tsconfig.json               # TypeScript configuration
├── vitest.config.mjs           # Vitest test configuration
└── package.json                # Dependencies and scripts

Documentation

Comprehensive documentation is available both on the site and in the repository:

Visit the documentation section on the site for the full documentation experience.

Technology Stack

Contributing

We welcome contributions! Please see our Contributing Guide for details on:

  • Code of conduct
  • Development workflow
  • Branching strategy
  • Pull request process
  • Code style guidelines

Before contributing, please read:

Related Projects

Security

For security concerns, please review our Privacy & Security documentation.

License

MIT

Branding & Attribution

The LogicStamp Fox mascot and related brand assets are © 2025 Amit Levi.

These assets may not be used for third-party branding, logos, or commercial identity without permission. They are included in this repository for documentation and non-commercial use within the LogicStamp ecosystem only.

Support

Community

This project follows a Code of Conduct. By participating, you agree to uphold it.

LogicStamp Fox Mascot

Open-source developer tooling

Website • GitHub Org • LogicStamp Context (CLI) • LogicStamp MCP