https://github.com/specui/specui

Build UIs with Specs
https://github.com/specui/specui

code-generation javascript specification typescript

Last synced: 3 days ago
JSON representation

Build UIs with Specs

• Host: GitHub
• URL: https://github.com/specui/specui
• Owner: specui
• License: mit
• Created: 2015-03-28T05:43:27.000Z (almost 10 years ago)
• Default Branch: main
• Last Pushed: 2024-10-29T12:55:18.000Z (4 months ago)
• Last Synced: 2024-10-29T15:21:03.232Z (4 months ago)
• Topics: code-generation, javascript, specification, typescript
• Language: TypeScript
• Homepage: https://specui.org
• Size: 16.5 MB
• Stars: 290
• Watchers: 8
• Forks: 24
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        




  



# SpecUI

Build apps with YAML.

[![License](https://img.shields.io/github/license/specui/specui.svg?style=flat-square)](https://github.com/specui/specui/blob/mistress/LICENSE)

[![npm](https://img.shields.io/npm/v/@specui/core?style=flat-square)](https://npm.im/@specui/core)

Spec. Preview. Ship.



## Overview

SpecUI is a powerful development tool designed to transform specs into fully functional user interfaces.

✍️ Write specs in:

- YAML

- JSON

- Or, JS/TS

⚡️ Generate code for:

- Any language: JavaScript, Go, Python, Ruby, Java

- Any framework: Next.js, Astro, Vue, Angular, Gorm, Django

- Any markup/format/other: HTML, JSON, YAML, CSS

## Quickstart

### CLI

Get up and running with SpecUI in seconds:

```bash

npx @specui/cli new

npx @specui/cli generate

pnpm install

pnpm dev

```

### VS Code Extension

Supercharge your workflow with our [VS Code Extension](https://marketplace.visualstudio.com/items?itemName=specui.specui).

## Docs

Read the docs: https://specui.org/docs

## Features

- **Continuous Code Generation**: Seamlessly update files when your specs or logic change.

- **Spec-Driven**: Keep everything aligned with your vision using structured, spec-based guidance.

- **Versatile**: Generate UI components, APIs, configuration files, and even entire mobile applications.

- **Framework Agnostic**: Build for React, Vue, Angular, or just Vanilla JS.

## How Does It Work?

SpecUI processes your specs using a series of Generators, Templates, and Processors to output clean, production-ready code. It's a spec-first approach that empowers you to ship faster than ever.

## License

SpecUI is released under the [MIT License](https://github.com/specui/specui/blob/main/LICENSE).