rustnext 0.1.1

A modern, fast web framework for Rust
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
143
144
145
146
147
148
149
150
151
152
153



```markdown
# RustNext Web Framework

![Rust](https://img.shields.io/badge/Rust-1.70+-blue)
![License](https://img.shields.io/badge/License-MIT-green)

A high-performance web framework for Rust inspired by Next.js, featuring:

- 🚀 Full-stack capabilities in a single codebase
- ⚡ Blazing fast performance
- 🧩 Declarative UI components
- 🔄 Built-in API routes
- 📝 Form handling utilities

## Table of Contents

- [Features](#-features)
- [Quick Start](#-quick-start)
- [Examples](#-examples)
- [Project Structure](#-project-structure)
- [Configuration](#-configuration)
- [Contributing](#-contributing)
- [License](#-license)

## ✨ Features

| Feature               | Description                                                                 |
|-----------------------|-----------------------------------------------------------------------------|
| **Type-safe APIs**    | Compile-time validated routes and handlers                                  |
| **UI Components**     | Reusable, declarative views with server-side rendering                      |
| **Zero Config**       | Sensible defaults with minimal setup required                               |
| **Middleware**        | Built-in auth, logging, and compression                                    |
| **Form Handling**     | Easy form parsing and validation                                           |
| **File Uploads**      | Streaming file upload support                                              |

## 🚀 Quick Start

1. Install Rust (if needed):
   ```bash
   curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
   ```

2. Create a new project:
   ```bash
   cargo new my_rustnext_app
   cd my_rustnext_app
   ```

3. Add RustNext to your dependencies:
   ```toml
   [dependencies]
   rustnext = "0.1"
   ```

4. Create your first component in `src/main.rs`:
   ```rust
   use rustnext::prelude::*;

   #[component]
   fn App() -> Markup {
       html! {
           h1 { "Hello RustNext!" }
       }
   }

   fn main() {
       RustNext::new()
           .route("/", App)
           .run();
   }
   ```

5. Run your app:
   ```bash
   cargo run
   ```

## 📚 Examples

### Project Dashboard

```bash
cargo run --example project_dashboard_app
```

**Demonstrates:**
- CRUD operations for projects and tasks
- Form validation
- Multi-entity relationships
- POST-redirect-GET pattern

### Product Catalog

```bash
cargo run --example product_catalog_app
```

**Demonstrates:**
- Product management
- Edit/delete workflows
- Search and filtering
- Pagination

Access both examples at: `http://localhost:3000`

## 📂 Project Structure

```
my_rustnext_app/
├── src/
│   ├── components/      # UI components
│   ├── pages/           # Page layouts
│   ├── api/             # API routes
│   └── main.rs          # Application entry
├── static/              # Static assets
├── Cargo.toml
└── config.toml          # Configuration
```

## ⚙️ Configuration

Edit `config.toml`:

```toml
[server]
host = "0.0.0.0"
port = 3000

[database]
url = "postgres://user:pass@localhost/db" # Optional

[features]
logging = true
compression = true
```

## 🤝 Contributing

We welcome contributions! Please:

1. Fork the repository
2. Create a feature branch
3. Submit a PR

See our [Contribution Guidelines](CONTRIBUTING.md) for details.

## 📜 License

MIT © [sazalo]
```