Skip to content

darkroomengineering/satus

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Mar 6, 2025
c8c1480 · Mar 6, 2025
Mar 6, 2025
Nov 4, 2024
Feb 19, 2025
Feb 28, 2025
Feb 28, 2025
Feb 27, 2025
Feb 28, 2025
Feb 27, 2025
Mar 5, 2025
Jan 27, 2025
Feb 28, 2025
Feb 27, 2025
Apr 17, 2024
Feb 3, 2025
Nov 11, 2024
Feb 10, 2025
Feb 27, 2025
Feb 7, 2025
Feb 27, 2025
Feb 4, 2025
Feb 7, 2025
Feb 27, 2025
Feb 27, 2025
Feb 7, 2025
Feb 10, 2025

Repository files navigation

SATUS

Satūs

A modern React application template with advanced features including WebGL graphics, animations, and CMS integration. Satūs means "start" or "beginning" in Latin, serving as a foundation for new projects.

Quick Setup

  1. Install dependencies:

    bun install
  2. Setup Vercel and environment variables:

    vercel link
    vercel env pull
  3. Start development server:

    bun dev

Project Structure

├── app/                          # Next.js application pages and routes
│   └── (pages)/                  # Page components and layouts
├── components/                   # Reusable UI components
│   ├── button/                   # Button components
│   ├── form/                     # Form components
│   ├── animation/                # Animation components
│   └── ...                       # Other UI components
├── hooks/                        # Custom React hooks
├── intergrations/                # Third party integrations
│   ├── hubspot/                  # Hubspot form integration
│   ├── storyblok/                # Storyblok CMS integration
│   └── shopify/                  # Shopify integration
├── libs/                         # Utility libraries and functions
├── orchestra/                    # Debugging and development tools
├── styles/                       # Styling system configuration and utilities
└── webgl/                        # WebGL and 3D graphics
    ├── components/               # WebGL components
    ├── hooks/                    # WebGL-specific hooks
    └── utils/                    # WebGL utilities

Core Technologies

  • Framework & Runtime

    • Next.js 15.2 App Router with React Server Components
    • React 19.0 with React Compiler for improved performance
    • Bun as JavaScript runtime and package manager
    • TypeScript with strict type checking
  • 3D & Graphics

  • Animation & Interaction

  • Content Management

  • Development Tools

    • Biome 1.9.4 for linting & formatting
    • Lefthook for Git hooks automation
    • Theatre.js Studio for animation debugging
    • Built-in debug tools at /orchestra
    • Hot module replacement
    • VSCode configuration included

Development Tools

Available Scripts

  • bun dev - Start development server with Turbo
  • bun dev:https - Start development server with HTTPS
  • bun build - Build the project for production
  • bun start - Start the production server
  • bun setup:styles - Generate style configuration files
  • bun watch:styles - Watch and rebuild styles on changes
  • bun typecheck - Run TypeScript type checking
  • bun lint - Run Biome linting
  • bun analyze - Analyze bundle sizes

Debug Features (at /orchestra)

  • Theatre.js Studio
  • FPS Meter
  • Grid Debugger
  • Minimap

Styling Architecture

  • System Overview

    • Tailwind CSS v4.0.9 with custom utilities
    • PostCSS with advanced configuration and functions
    • CSS Modules for component styles
    • Responsive viewport-based units
  • Key Features

    • Viewport-relative units (mobile-vw, desktop-vw)
    • Custom responsive grid system (configurable in styles/layout.mjs)
    • Pre-defined breakpoints (800px desktop threshold)
    • Typography system with SERVER MONO font
    • Theme support
    • Custom scaling utilities with 's' prefix
  • Build Process

    • Automated style generation with setup:styles script
    • CSS optimization with cssnano in production
    • Type-safe theme properties and configuration

For more details on the styling system, see styles/README.md.

Git Workflow

Automated Git Hooks (via Lefthook)

  • Pre-commit: Runs Biome to check and format staged files
  • Post-merge: Automatically pulls latest environment variables from Vercel

Documentation

Deployment

The project can be deployed on Vercel, Netlify, or any service supporting Next.js. See PROD-README.md for production-specific details.

License

MIT © darkroom.engineering