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

{
  "name": "server",
  "description": "A Rust web server template",
  "type": "binary",
  "files": [
    {
      "source": "README.md",
      "target": "README.md"
    }
  ],
  "options": [
    {
      "name": "framework",
      "description": "Which web framework would you like to use?",
      "type": "select",
      "options": ["axum", "actix", "poem"],
      "default": "axum"
    }
  ],
  "conditional_files": [
    {
      "when": "framework == 'axum'",
      "files": [
        {
          "source": "axum/src/main.rs",
          "target": "src/main.rs"
        },
        {
          "source": "axum/Cargo.toml.template",
          "target": "Cargo.toml"
        }
      ]
    },
    {
      "when": "framework == 'actix'",
      "files": [
        {
          "source": "actix/src/main.rs",
          "target": "src/main.rs"
        },
        {
          "source": "actix/Cargo.toml.template",
          "target": "Cargo.toml"
        }
      ]
    },
    {
      "when": "framework == 'poem'",
      "files": [
        {
          "source": "poem/src/main.rs",
          "target": "src/main.rs"
        },
        {
          "source": "poem/Cargo.toml.template",
          "target": "Cargo.toml"
        }
      ]
    }
  ],
  "dependencies": {
    "default": [
      "tokio = { version = \"1.36\", features = [\"full\"] }",
      "serde = { version = \"1.0\", features = [\"derive\"] }",
      "serde_json = \"1.0\""
    ],
    "axum": [
      "axum = \"0.7\"",
      "tower = \"0.4\"",
      "tower-http = { version = \"0.4\", features = [\"fs\", \"trace\"] }",
      "tracing = \"0.1\"",
      "tracing-subscriber = \"0.3\""
    ],
    "actix": [
      "actix-web = \"4.5\"",
      "actix-rt = \"2.9\"",
      "env_logger = \"0.11\"",
      "log = \"0.4\""
    ],
    "poem": [
      "poem = \"2.0\"",
      "tracing = \"0.1\"",
      "tracing-subscriber = \"0.3\""
    ]
  },
  "dev-dependencies": {
    "default": [
      "reqwest = { version = \"0.11\", features = [\"json\"] }"
    ]
  },
  "next_steps": {
    "default": [
      "cd {{project_name}}",
      "cargo run"
    ],
    "conditional": [
      {
        "when": "framework == 'axum'",
        "steps": [
          "# Test the API with: curl http://localhost:3000/",
          "# Add more routes in src/main.rs",
          "# Enable OpenAPI with: axum-openapi = \"0.1\""
        ]
      },
      {
        "when": "framework == 'actix'",
        "steps": [
          "# Test the API with: curl http://localhost:8080/",
          "# Add more routes in src/main.rs",
          "# Explore middleware in Actix with actix-web-middleware"
        ]
      },
      {
        "when": "framework == 'poem'",
        "steps": [
          "# Test the API with: curl http://localhost:3000/",
          "# Add more routes in src/main.rs",
          "# Enable OpenAPI with: poem-openapi = \"3.0.0\""
        ]
      }
    ]
  }
}