ferrisup 0.2.5

A versatile Rust project bootstrapping tool - start anywhere, scale anywhere
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

# {{project_name}}

A web server implementation using Rust and the **{{server_framework}}** framework.

## Features

{{#if (eq server_framework "axum")}}
- Type-safe routing with Axum
- Tower middleware integration 
- Extensible extractors
- JSON request/response handling
- Async request processing with Tokio
{{else}}{{#if (eq server_framework "actix")}}
- High-performance HTTP handling
- Support for HTTP/1.x and HTTP/2
- Actix actor system integration
- Flexible middleware system
- WebSockets support
{{else}}{{#if (eq server_framework "poem")}}
- Ergonomic API design with Poem
- OpenAPI integration capability
- Middleware support
- WebSockets capabilities
- Multipart file handling
{{/if}}{{/if}}{{/if}}

## Getting Started

### Prerequisites

- Rust toolchain (1.70.0 or later recommended)
- Cargo package manager

### Running the Server

```bash
cd {{project_name}}
cargo run
```

The server will start and listen on:
{{#if (eq server_framework "actix")}}
- http://localhost:8080
{{else}}
- http://localhost:3000
{{/if}}

### Testing the API

```bash
# Health check
{{#if (eq server_framework "actix")}}
curl http://localhost:8080/
{{else}}
curl http://localhost:3000/
{{/if}}

# Echo endpoint (sends back the JSON you provide)
{{#if (eq server_framework "actix")}}
curl -X POST http://localhost:8080/echo -H "Content-Type: application/json" -d '{"message": "Hello World"}'
{{else}}
curl -X POST http://localhost:3000/echo -H "Content-Type: application/json" -d '{"message": "Hello World"}'
{{/if}}
```

## Framework Details

{{#if (eq server_framework "axum")}}
### About Axum

Axum is a web application framework focusing on ergonomics and modularity. It's built on top of Tokio, Tower, and Hyper.

Resources:
- [Axum Documentation](https://docs.rs/axum/latest/axum/)
- [GitHub Repository](https://github.com/tokio-rs/axum)
- [Tokio Discord](https://discord.gg/tokio)
{{else}}{{#if (eq server_framework "actix")}}
### About Actix Web

Actix Web is a powerful, pragmatic, and extremely fast web framework for Rust, built on top of the actor system provided by the Actix crate.

Resources:
- [Actix Web Documentation](https://actix.rs/docs/)
- [GitHub Repository](https://github.com/actix/actix-web)
- [Discord Community](https://discord.gg/actix)
{{else}}{{#if (eq server_framework "poem")}}
### About Poem

Poem is a full-featured, easy-to-use web framework with a focus on ergonomics, modularity, and extensibility.

Resources:
- [Poem Documentation](https://docs.rs/poem/latest/poem/)
- [GitHub Repository](https://github.com/poem-web/poem)
- [API Reference](https://docs.rs/poem)
{{/if}}{{/if}}{{/if}}

## Project Structure

```
{{project_name}}/
├── src/
│   └── main.rs       # Server application entry point
├── Cargo.toml        # Project dependencies
└── README.md         # This file
```

## Potential Enhancements

{{#if (eq server_framework "axum")}}
- Add Tower middleware for authentication
- Implement API versioning
- Add OpenAPI/Swagger with utoipa
- Add database integration (SQLx recommended for Axum)
{{else}}{{#if (eq server_framework "actix")}}
- Implement actor-based background workers
- Add database integration with Diesel
- Create RESTful resource handlers
- Add authentication middleware
{{else}}{{#if (eq server_framework "poem")}}
- Add OpenAPI integration with poem-openapi
- Implement API versioning
- Add database connectivity
- Create comprehensive error handling
{{/if}}{{/if}}{{/if}}

## License

This project is licensed under the MIT License.