allframe-forge 0.1.8

AllFrame CLI - Project scaffolding and code generation
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142

# allframe-forge

**AllFrame CLI - Project scaffolding and code generation**

[![Crates.io](https://img.shields.io/crates/v/allframe-forge.svg)](https://crates.io/crates/allframe-forge)
[![Documentation](https://docs.rs/allframe-forge/badge.svg)](https://docs.rs/allframe-forge)
[![License](https://img.shields.io/badge/license-MIT%20OR%20Apache--2.0-blue.svg)](../../LICENSE-MIT)

The AllFrame CLI tool for creating and managing AllFrame projects.

## Installation

```bash
cargo install allframe-forge
```

## Usage

### Create New Project

```bash
# Create a new AllFrame project
allframe ignite my-api

# Navigate to the project
cd my-api

# Run the API
cargo run
```

### Project Structure

The generated project includes:

```
my-api/
├── Cargo.toml
├── src/
│   ├── main.rs           # Application entry point
│   ├── handlers/         # API handlers
│   ├── domain/           # Domain models
│   └── infrastructure/   # Database, config, etc.
├── tests/                # Integration tests
└── examples/             # Usage examples
```

### Features

- ✅ **Clean Architecture** - Proper separation of concerns
- ✅ **Protocol-Agnostic** - REST, GraphQL, gRPC support
- ✅ **CQRS Ready** - Command/Query separation
- ✅ **Test Setup** - Pre-configured test infrastructure
- ✅ **Best Practices** - Industry-standard project structure

## Commands

```bash
# Create new project
allframe ignite <name>

# Generate handler
allframe generate handler <name>

# Generate command (CQRS)
allframe generate command <name>

# Generate query (CQRS)
allframe generate query <name>
```

## Project Templates

### Minimal
```bash
allframe ignite my-api --template minimal
# Simple REST API with basic routing
```

### Full
```bash
allframe ignite my-api --template full
# Complete setup with REST, GraphQL, gRPC, and CQRS
```

### CQRS
```bash
allframe ignite my-api --template cqrs
# CQRS-focused architecture with event sourcing
```

## Configuration

Generated projects use `allframe-core` with sensible defaults:

```toml
[dependencies]
allframe-core = { version = "0.1", features = [
    "di",
    "openapi",
    "router",
    "otel"
] }
```

## Development

After creating a project:

```bash
# Run the API
cargo run

# Run tests
cargo test

# Run with specific features
cargo run --features graphql,grpc

# View API documentation
# Visit http://localhost:8080/docs after starting
```

## Examples

See the [examples/](../../examples/) directory in the AllFrame repository for complete project examples.

## License

Licensed under either of:

- Apache License, Version 2.0 ([LICENSE-APACHE](../../LICENSE-APACHE))
- MIT license ([LICENSE-MIT](../../LICENSE-MIT))

at your option.

## Resources

- **AllFrame Core**: https://crates.io/crates/allframe-core
- **Documentation**: https://docs.rs/allframe-forge
- **Repository**: https://github.com/all-source-os/all-frame
- **Issues**: https://github.com/all-source-os/all-frame/issues