🧱 ziegel

Appearance

Getting Started ​

Welcome to ziegel, a comprehensive, modular TypeScript framework for building enterprise-grade applications. This guide will help you get up and running with ziegel in just a few minutes.

What is ziegel? ​

ziegel is a collection of carefully crafted TypeScript packages that work together to deliver a complete development platform. Each package is designed to be:

  • Modular: Use only what you need
  • Type-safe: Full TypeScript support with comprehensive type definitions
  • Enterprise-ready: Built for scalability and maintainability
  • Developer-friendly: Intuitive APIs with excellent developer experience

Quick Start ​

Prerequisites ​

Before you begin, ensure you have the following installed:

  • Node.js 18+
  • npm, yarn, or pnpm
  • TypeScript 4.8+

Installation ​

ziegel packages are available on npm and can be installed individually based on your needs:

bash
# Core package (required)
npm install @breadstone/ziegel-core

# Platform services
npm install @breadstone/ziegel-platform

# HTTP utilities
npm install @breadstone/ziegel-platform-http

# Internationalization
npm install @breadstone/ziegel-intl

# And many more...

Your First ziegel App ​

Here's a simple example to get you started:

typescript
import { Ensure, StringExtensions, Action } from '@breadstone/ziegel-core';
import { HttpClient } from '@breadstone/ziegel-platform-http';
import { CultureInfo } from '@breadstone/ziegel-intl';

// Use core utilities
const formatted = StringExtensions.format('Hello, {0}!', 'World');
console.log(formatted); // "Hello, World!"

// Type-safe validation
Ensure.notNull(formatted, 'formatted');

// Setup HTTP client
const httpClient = new HttpClient({
  baseURL: 'https://api.example.com',
  timeout: 5000
});

// Culture management
const culture = new CultureInfo('en-US');
console.log('Current culture:', culture.displayName);

// Action pattern
const userAction = new Action<string>('UserUpdated');
userAction.subscribe(data => console.log('User updated:', data));
userAction.invoke('john.doe');

Next Steps ​

Now that you have ziegel installed, explore these guides:

Need Help? ​

Ready to dive deeper? Continue with the Architecture Overview to understand ziegel's design principles.