Skip to content

internet-development/www-sacred

Repository files navigation

SRCL

Live Demo

SRCL is an open-source React component and style repository that helps you build web applications, desktop applications, and static websites with terminal aesthetics. Its modular, easy-to-use components emphasize precise monospace character spacing and line heights, enabling you to quickly copy and paste implementations while maintaining a clean, efficient codebase.

npm install
npm run dev

Go to http://localhost:10000 in your browser of choice.

We use Vercel for hosting.

Scripts (Optional)

If you need to run node script without running the server, use this example to get started

npm run script example

Tests

Run the unit tests for the sacred CLI framework primitives:

npm test

This runs two suites in sequence: the JavaScript vitest suite under scripts/cli/lib/__tests__ and the Python unittest suite under scripts/python/sacred_cli/__tests__. The Python suite includes a parity test that asserts byte-identical output between the two runtimes for every public layout primitive — change a JS module and the Python mirror must follow in the same PR or npm test fails. If python3 is not on PATH, the Python suite skips with a warning (so contributors on minimal containers can still run npm test). Use npm run test:js or npm run test:python to run a single suite.

Sacred CLI Templates

Sacred ships a tiny zero-dependency CLI framework under scripts/cli/lib. The framework reads its palette from scripts/cli/colors.json so the terminal surface and the React surface stay in agreement. Two reference templates render the same data set in two languages:

npm run cli:typescript
npm run cli:python

cli:typescript runs scripts/cli/templates/template.ts via tsx. cli:python runs scripts/python/templates/template.py against a snake_case Python mirror of the framework under scripts/python/sacred_cli. Both screens use the alt screen buffer and raw mode keyboard input — press q or Esc to exit. The same template is also mounted as a React component on the kitchen sink page (search for CLI TEMPLATE EXAMPLE).

If you want to write your own CLI screen or port a sacred React surface to a terminal, the four skills under skills/ walk through the conventions:

  • skills/port-sacred-terminal-ui-to-typescript-cli/SKILL.md
  • skills/port-sacred-terminal-ui-to-python/SKILL.md
  • skills/port-sacred-terminal-ui-to-react-using-same-conventions/SKILL.md
  • skills/port-sacred-terminal-ui-to-hostile-react-codebase/SKILL.md

Documentation URLs

Sacred Computer (the React framework) and Simulacrum (the CLI framework under scripts/cli/ and scripts/python/) are two halves of one project — both render the same primitives, both load the same palette from scripts/cli/colors.json, and both share a single doc surface. Every AGENTS.md and SKILL.md in the repo is published as raw markdown at a stable URL so coding agents can fetch them without cloning:

The URL set is built from the filesystem at compile time — app/llm/[...path]/route.ts calls generateStaticParams() against the same listDocs() helper used by /llms.txt and /llms-full.txt, so adding a new AGENTS.md or SKILL.md to the repo automatically exposes it at https://sacred.computer/llm/<repo-relative-path> and a vitest URL guard fails CI if the on-disk doc set drifts from the served URL set. Both /llms.txt and /llms-full.txt follow the llmstxt.org convention.

Contact

If you have questions ping me on Twitter, @wwwjim. Or you can ping @internetxstudio.

About

SRCL is an open-source React component and style repository that helps you build web applications, desktop applications, and static websites with terminal aesthetics.

Topics

Resources

License

Stars

Watchers

Forks

Contributors