⚛️ AZtomiq

A high-performance, privacy-first, and ultra-modular multi-tool website framework. Built with a passion for simplicity and speed.

Live Demo • Report Bug • Request Feature

In production

AZtomiq powers:

• https://ztools.site — a full-scale utility tools platform

---

🌟 Why AZtomiq?

AZtomiq isn't just another static site generator. It's an Ecosystem designed for building professional utility toolkits.

• ⚛️ Atomic Architecture: Every feature is a self-contained "Atom". Zero global dependencies, maximum portability.
• 🛡️ Privacy by Design: 100% Client-side processing. No data ever leaves the user's browser.
• 🌍 Production Ready i18n: Built-in multi-lingual support with atomic translation merging.
• ⚡ Blazing Fast: No heavy JS frameworks. Powered by Vanilla JS and optimized EJS templates.
• 📱 Modern PWA: Fully offline-capable with automated Service Worker generation.

---

🏗️ Core Architecture

.
├── bin/              # 🛠️ Main CLI entry point
├── docs/             # 📚 Documentation & Guides
├── scripts/          # ⚙️ Modular build logic (Pages, Assets, Cache)
├── src/
│   ├── assets/       # 🎨 Global Design System (CSS/JS)
│   ├── data/         # 📊 Global site & category metadata
│   ├── features/     # ⚛️ Atomic Tools (The heart of AZtomiq)
│   ├── includes/     # 🧩 Reusable EJS components
│   ├── locales/      # 🌍 System-wide translations
│   ├── pages/        # 📄 Static landing & system pages
│   └── templates/    # 🧬 SEO & PWA generators
└── package.json

---

🚀 Quick Start

0. Prerequisites

• Node.js: v18.0.0 or higher
• NPM: v8.0.0 or higher
• Git: For deployment

1. Installation

Option A: Scaffolding a new project (Recommended)

npx aztomiq init my-awesome-app
cd my-awesome-app
npm install

Option B: Manual Installation

git clone https://github.com/ph4n4n/aztomiq.git
cd aztomiq
npm install

2. Development

Start the watcher and local server:

npm run dev

3. Creating Your First Tool

Use our CLI to scaffold a new feature instantly:

npm run aztomiq tool:create my-awesome-tool

4. Build for Production

Generate the static site in the dist/ folder:

npm run build

5. Deployment

Ship it to GitHub Pages (configured in global.yaml):

npm run deploy

---

📚 Documentation

Dive deeper into how AZtomiq works:

• 📂 Project Structure - Understand the folder organization.
• ⚛️ Atomic Features - Deep dive into tool architecture.
• 🛠️ CLI Reference - Master the power of the aztomiq command.
• ⚙️ Development Guide - Rules and best practices for creating tools.
• 📈 Deployment Guide - How to ship to production.
• 📜 Project Changelog - Track the evolution of the framework.

---

🤝 Contribution

We love contributors! If you have a cool tool idea:

1. Fork the Project.
2. Create your Feature Branch (git checkout -b feature/AmazingTool).
3. Create your tool using npm run aztomiq tool:create.
4. Commit your Changes.
5. Push to the Branch.
6. Open a Pull Request.

---

📜 License

Distributed under the MIT License. See LICENSE for more information.

---

Built with ❤️ by the AZtomiq Team
"Fast. Simple. Atomic."