Skip to content

BOUNDARIES.md

Latest commit

 

History

History
64 lines (48 loc) · 1.83 KB

BOUNDARIES.md

File metadata and controls

64 lines (48 loc) · 1.83 KB

Satus Philosophy: Simple Customization

Satus is designed to be simple to use while remaining upgrade-safe. No complex rules or folder decisions - just common sense.

Simple Rule

One decision to make: Am I building my project or extending the starter?

  • Building your project -> Modify freely (pages, styling, content)
  • Extending the starter -> Create alongside existing components

What You'll Find

app/                 # Your pages & routes - customize freely
components/          # Mix of starter + your components
  ui/                # Starter UI primitives
  layout/            # Starter layout (Header/Footer)
  effects/           # Starter animations
lib/
  utils/             # Starter utilities
  integrations/      # Starter service integrations
  webgl/             # Starter WebGL system
  styles/            # Starter design system

How to Customize

Your Pages & Content

// app/page.tsx - Your homepage
export default function Home() {
  return (
    <Wrapper theme="dark">
      <h1>My Project</h1>
      {/* Your content here */}
    </Wrapper>
  )
}

Your Components

// components/my-hero.tsx - Add alongside starter components
export function MyHero() {
  return <section>My custom hero section</section>
}

Customize Starter Features

To enable or disable features, directly edit the relevant integration code or remove unused integrations entirely. See lib/integrations/README.md for details on each integration.

For AI Assistants

Simple rule: Modify pages and content freely, extend starter components by creating new ones alongside.

Upgrade Safety

Want starter updates to work smoothly?

  • Create new components instead of modifying existing ones
  • Keep your pages and content separate from starter utilities

That's it! No complex rules, just common sense.