Skip to content

Latest commit

 

History

History

README.md

JetCrab Documentation

JetCrab Logo

JetCrab Documentation

A modern JavaScript runtime implemented in Rust, powered by the Chitin (WASM) JavaScript engine

License: MIT Rust Chitin Tokio Build Status Coverage

Welcome to the JetCrab documentation! This directory contains comprehensive documentation for the JetCrab JavaScript runtime.

📚 Documentation Structure

🚀 Getting Started

📖 User Guides

🏗️ Architecture & Development

📦 Distribution & Installation

🚀 Quick Start

If you're new to JetCrab, follow this path:

  1. Install JetCrab - Get JetCrab running on your system
  2. Quick Start - Learn the basics in 5 minutes
  3. JetCrab Guide - Comprehensive usage guide
  4. Examples - See JetCrab in action

📖 Reading Paths

For New Users

  1. Installation Guide
  2. Quick Start Guide
  3. JetCrab Guide
  4. Examples

For Developers

  1. Architecture Overview
  2. Implementation Status
  3. API Reference
  4. Contributing Guide

For Contributors

  1. Contributing Guide
  2. Architecture Overview
  3. Implementation Status
  4. Development Setup

🎯 Key Features

Core Runtime

  • JavaScript Execution: Full JavaScript support via Chitin engine
  • Built-in APIs: Console, Process, Fetch, and more
  • Async Operations: Tokio integration for asynchronous I/O
  • CLI Interface: Command-line tools for running JavaScript

Development Tools

  • Package Management: CPM package manager
  • Hot Reload: Development server with automatic reloading
  • Linting & Formatting: Code quality tools
  • Testing: Built-in testing framework

Advanced Features

  • Rust Integration: Use Rust modules in JavaScript
  • WebAssembly Support: Run WASM modules
  • Module System: ES Modules and CommonJS support
  • Performance Monitoring: Built-in performance tools

📝 Documentation Status

  • Installation Guide - Complete
  • Quick Start Guide - Complete
  • JetCrab Guide - Complete
  • Architecture Overview - Complete
  • CPM Package Manager - Complete
  • CLI Reference - Complete
  • API Reference - Complete
  • Examples - Complete
  • Contributing Guide - Complete
  • Building from Source - Complete
  • Distribution Strategy - Complete

🤝 Contributing to Documentation

Documentation improvements are always welcome! If you find an error or want to add something:

  1. Check if the issue already exists
  2. Create a new issue or pull request
  3. Follow the Contributing Guidelines

🔗 External Resources


JetCrab v0.4.0 - Modern JavaScript Runtime in Rust 🦀