# Semantq

**Semantq** is an AI-first, full-stack JavaScript framework for building reactive web applications and embedded (IoT) systems, including hardware, firmware, and software. The philosophy of Semantq is Laser-Focused Automation with fine-grained Control.

## Table of Contents
- [Features](#features)
- [Installation](#installation)
  - [Via npm](#install-via-npm)
  - [Global Installation](#install-globally-for-use-anywhere-on-your-system)
- [Getting Started](#getting-started)
  - [Create a New Project](#create-a-new-project)
  - [Development Server](#run-the-development-server)
- [Documentation](#documentation)
  - [Core Features](#core-features)
  - [Template System](#template-system)
  - [Application Architecture](#application-architecture)

## Features
- Full-stack JavaScript support
- Reactive web applications
- Embedded IoT hardware and firmware integration
- AI-assisted development
- Declarative logic blocks in HTML
- Comprehensive state management

## Installation

### Install via npm
```bash
npm install semantq
```

### Install Globally (for use anywhere on your system)
```bash
npm install -g semantq
```

## Getting Started

### Create a New Project
```bash
npx semantq create myapp
# Or if installed globally:
semantq create myapp
```

### Run the Development Server
```bash
cd myapp
npm run dev
```
Your app will be available at `http://localhost:5173` (or the default port).

If you want to build full stack app please follow this guide: - [Semantq Full Stack Architecture](docs/SemantqQL.md) - Full Server set up with a robust plug and play database driven authentication.


## Documentation


### Core Features
- [Semantq AI CLI Guide](docs/SemantqAI.md) - Generate compliant code using AI
- [Semantq Config Guide](docs/SemantqConfig.md) - Manage app configuration
- [Semantq State Guide](docs/SemantqState.md) - Reactive state management system
- [Semantq Core State Guide](docs/SemantqStateCore.md) - Core state management
- [Semantq Reactivity Guide](docs/SemantqCoreReactivity.md) - Semantq Reactivity Guide

### Template System
- [If Logic Block](docs/logicBlocks/if.md) - If Logic Block Guide
- [Each Logic Block](docs/logicBlocks/each.md) - Each Logic Block Guide
- [Syntax Guide](docs/SemantqSyntaxComprehensive.md) - Comprehensive syntax reference
- [Slot Composition](docs/SemantqSlots.md) - Component slot patterns
- [Layout System](docs/SemantqLayouts.md) - Application layout management

### Application Architecture
- [Semantq CLI](docs/SemantqCli.md) - Command line interface
- [Semantq Full Stack Architecture](docs/SemantqQL.md) - Full Server set up with a robust plug and play database driven authentication.

## **License**

Semantq is open-source software licensed under the **MIT License**.

## Semantq Main Documentation: [Semantq](https://github.com/Gugulethu-Nyoni/semantq).