1.0.0 • Published 4 months ago

@tiger-framework/core v1.0.0

Weekly downloads
-
License
MIT
Repository
github
Last release
4 months ago

🐯 Tiger Framework

Tiger is a modern, lightweight web framework built on top of Bun that enables you to create beautiful, performant web applications with a simple and intuitive syntax.

✨ Features

  • ⚔ Lightning Fast: Built on Bun for maximum performance and minimal overhead
  • šŸŽØ Beautiful Design: Intuitive component system with built-in responsive design
  • šŸ› ļø Developer Friendly: TypeScript support and great developer experience
  • šŸ“± Responsive by Default: Automatic responsive design system for all components
  • šŸ”„ Multi-Page Support: Built-in routing and multi-page application support
  • šŸŽÆ Simple Syntax: JSX-like syntax that's easy to learn and use

šŸš€ Quick Start

Prerequisites

  • Bun installed on your system

Installation

# Clone the repository
git clone https://github.com/yourusername/tiger-framework.git
cd tiger-framework

# Install dependencies
bun install

Development

# Start the development server
bun run dev

# Build for production
bun run build

# Serve production build
bun run serve

šŸ“– Usage

Creating a Component

Components in Tiger use a simple, JSX-like syntax:

const MyComponent = () => {
  return (
    <>
      <view className="container">
        <text as="h1">Hello Tiger!</text>
        <text>Welcome to my component</text>
      </view>
    </>
  );
};

export default MyComponent;

Built-in Elements

Tiger provides several built-in elements:

  • <view>: Container element (renders as div)
  • <text>: Text element with optional as prop for semantic HTML
  • <link>: Navigation element
  • <button>: Interactive button element

Styling

Tiger uses class-based styling with automatic responsive design:

.container {
  max-width: 1200px;
  margin: 0 auto;
  padding: 2rem;
}

Routing

Create pages in the src/pages directory:

src/
  pages/
    page.tiger    # Home page (/)
    about/
      page.tiger  # About page (/about)

šŸ—ļø Project Structure

tiger-framework/
ā”œā”€ā”€ src/
│   ā”œā”€ā”€ build/          # Build system
│   ā”œā”€ā”€ dev/           # Development server
│   ā”œā”€ā”€ pages/         # Application pages
│   ā”œā”€ā”€ template.html  # HTML template
│   └── App.css       # Global styles
ā”œā”€ā”€ dist/             # Production build
ā”œā”€ā”€ package.json
└── README.md

šŸ› ļø Development Commands

  • bun run dev: Start development server
  • bun run build: Build for production
  • bun run serve: Serve production build
  • bun run clean: Clean build directory

šŸ¤ Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

šŸ“ License

This project is licensed under the MIT License - see the LICENSE file for details.

šŸ™ Acknowledgments

  • Built with Bun
  • Inspired by React and modern web frameworks
1.0.0

4 months ago