Installing the command-line executable

Assuming you have Rust/Cargo installed, run this command in a terminal:

cargo install prkserver

It will make the prkserver command available in your PATH if you've allowed the PATH to be modified when installing Rust. cargo uninstall prkserver uninstalls.

Back to the crate overview.

Readme

prkserver

prkserver is a CLI tool that helps create a backend server in Rust using Axum or Actix Web and SQLx. It configures everything based on a provided config.toml file.

Features

Generates a Rust backend project using Axum or Actix Web for HTTP handling.
Configures SQLx for database interactions.
Supports PostgreSQL and MySQL databases.
Creates models, middlewares and endpoints as specified in the config.toml file.

Installation

To install prkserver, use cargo:

cargo install prkserver

Usage

To use prkserver, create a config.toml file that defines the project configuration. Here is an example config.toml file:

project_name = "backend_project"
database_url = "mysql://user:password@localhost/database_name"
database_type = "mysql" # postgres, mysql, sqlite

framework="Axum" #Axum, ActixWeb

[[models]]
name = "User"
table_name = "users"
fields = [
    { name = "id", type = "i32" },
    { name = "username", type = "String" },
    { name = "email", type = "String" },
]
endpoints = [
    { method = "GET", path = "/users" },
    { method = "POST", path = "/users", body_params = [
        { name = "username", type = "String" },
        { name = "email", type = "String" },
    ] },
]


[[models]]
name = "Todo"
table_name = "todos"
fields = [
    { name = "id", type = "i32" },
    { name = "task", type = "String" },
    { name = "description", type = "Option<String>" },
]
endpoints = [
    { method = "GET", path = "/todos", middlewares = [
        "UserLoginHistoryMiddleware",
    ]  },
    { method = "POST", path = "/todos", middlewares = [
        "UserLoginHistoryMiddleware",
    ], body_params = [
        { name = "task", type = "String" },
        { name = "description", type = "Option<String>" },
    ]  },
    { method = "GET", path = "/todos/{id}", path_params = [
        { name = "id", type = "i32" },
    ] },
]

[[models]]
name = "UserLoginHistory"
table_name = "user_login_history"
fields = [
    { name = "id", type = "i32" },
    { name = "user_id", type = "i32" },
    { name = "token", type = "String" },
]

[[middlewares]]
model = "UserLoginHistory"
select_from_model = "UserLoginHistory"
validate_header = [{ model_field = "token", header_key = "token" }]

Once you have your config.toml file, run prkserver at the path of this config file:

prkserver

This will generate a new project in a directory named after project_name specified in the config.toml.

Note: Still work in Progress.