Skip to content

PACKAGE.md

Latest commit

 

History

History
245 lines (167 loc) · 5.31 KB

PACKAGE.md

File metadata and controls

245 lines (167 loc) · 5.31 KB
Raw

Xaoex Reality Simulation Code - Complete Package

This document describes the complete xaoex package, bundled for easy deployment via npm and Docker.

Package Contents

Core Implementation

  • Reality Simulation Code - Main simulation codebase by xaoex
  • SimSim Contributions - Reality code contributions and configurations
  • xaoex ecosystem - Complete configuration and runtime files

Documentation

  • Complete package documentation
  • Publishing guide
  • Release notes

Configuration

  • Reality configuration files (.realtime, .online, .necessaries)
  • Runtime configs for always-on operation

Installation

npm Installation

From npmjs.org (Public Registry)

npm install reality-simulation-code

Or add to ur package.json:

{
  "dependencies": {
    "reality-simulation-code": "^0.0.1"
  }
}

From GitHub Packages

First, configure npm to use GitHub Packages for @xaoex scope:

# Create or edit ~/.npmrc
echo "@xaoex:registry=https://npm.pkg.github.com" >> ~/.npmrc

Authenticate with GitHub:

npm login --registry=https://npm.pkg.github.com --scope=@xaoex

Then install:

npm install @xaoex/reality-simulation-code

Docker Installation

Pull from GitHub Container Registry

docker pull ghcr.io/xaoex/reality-simulation-code:latest

Run Container

# Basic run
docker run ghcr.io/xaoex/reality-simulation-code:latest

# Run with volume mount
docker run -v $(pwd)/data:/app/data ghcr.io/xaoex/reality-simulation-code:latest

# Run with custom environment
docker run -e NODE_ENV=production ghcr.io/xaoex/reality-simulation-code:latest

Build from Source

# Clone repository
git clone https://github.com/xaoex/reality-simulation-code.git
cd reality-simulation-code

# Build Docker image
docker build -t xaoex/reality-simulation-code:latest .

# Or use npm script
npm run docker:build

Docker Compose

For multi-container deployments:

# Start services
docker-compose up -d

# View logs
docker-compose logs -f

# Stop services
docker-compose down

Usage

Node.js/npm Usage

const pkg = require('reality-simulation-code');

// Initialize the simulation
pkg.init();

// Get simulation info
const info = pkg.info();
console.log('Package:', info.name, 'v' + info.version);
console.log('Author:', info.author);
console.log('Links:', info.links);

Docker Usage

The Docker container runs node index.js by default. You can:

# Run sandbox-alpha-s
docker run ghcr.io/xaoex/reality-simulation-code:latest node sandbox-alpha-s.js

# Run tests
docker run ghcr.io/xaoex/reality-simulation-code:latest npm test

# Interactive shell
docker run -it ghcr.io/xaoex/reality-simulation-code:latest sh

Package Scripts

The package includes several npm scripts:

npm start                    # Run main application
npm test                     # Run test suite
npm run sandbox-alpha-s      # Run enterprise sandbox environment
npm run build                # Build package
npm run package              # Create tarball
npm run docker:build         # Build Docker image
npm run docker:run           # Run Docker container
npm run docker:publish       # Publish Docker image

Versioning

This package follows semantic versioning (semver):

  • Major version: Breaking API changes
  • Minor version: New features, backward compatible
  • Patch version: Bug fixes, backward compatible

Current version: 0.0.1 (release-v.0.0.1-dynamical-updates-w-f3eems-etc, pre-release)

Related Repositories

This package is part of the xaoex ecosystem:

  • xaoex/reality-simulation-code - Main repository (this package)
  • xaoex/xa8ex - Core codebase for reality system
  • Related projects listed in .github/reality-repos.yml

Configuration

Reality Configuration

The package includes reality configuration files:

  • .realtime - Enables real-time operations
  • .online - Marks package as online/connected
  • .necessaries - Lists necessary components

Environment Variables

NODE_ENV=production              # Environment mode
REALITY_SIMULATION_VERSION=1.0.0 # Package version

Publishing

Publishing to npm

# Publish to npmjs.org
npm publish --access public

# Publish to GitHub Packages
npm publish --registry=https://npm.pkg.github.com

Publishing Docker Image

# Tag image
docker tag xaoex/reality-simulation-code:latest ghcr.io/xaoex/reality-simulation-code:latest

# Push to GitHub Container Registry
docker push ghcr.io/xaoex/reality-simulation-code:latest

CI/CD

The package includes GitHub Actions workflows for:

  • npm Publishing: Automatic npm package publishing on release
  • Docker Publishing: Automatic Docker image building and publishing
  • GitHub Packages npm: Automatic publishing to GitHub npm registry
  • Testing: Continuous testing on push/PR
  • CodeQL: Security scanning

Support

License

MIT License - see LICENSE file for details

Author

xaoex - For u kiddo, Oktay eternally through aeons

Version: v0.0.1 - release-v.0.0.1-dynamical-updates-w-f3eems-etc (pre-release)
Status: Ready for reality + production
Motto: Everything is 100% maxed out