-Créons un blog coté serveur sur Loco en quelques minutes. Commençons par installer `loco-cli` et `sea-orm-cli`: +Créons un blog coté serveur sur Loco en quelques minutes. Commençons par installer `loco` et `sea-orm-cli`: ```sh -cargo install loco-cli +cargo install loco cargo install sea-orm-cli # Only when DB is needed ``` @@ -146,7 +146,7 @@ $ curl localhost:5150/posts Pour ceux qui comptent -- les commandes pour créer un backend de blog étaient: -1. `cargo install loco-cli` +1. `cargo install loco` 2. `cargo install sea-orm-cli` 3. `loco new` 4. `cargo loco generate scaffold post title:string content:text` diff --git a/loco-cli/src/bin/main.rs b/loco-cli/src/bin/main.rs index 44deca9b0..866473bd5 100644 --- a/loco-cli/src/bin/main.rs +++ b/loco-cli/src/bin/main.rs @@ -51,6 +51,17 @@ enum Commands { } #[allow(clippy::unnecessary_wraps)] fn main() -> eyre::Result<()> { + println!(""); + println!(""); + println!("!!!!!"); + println!("!!!!! NOTE: `loco-cli` is now replaced with `loco` which is a much more powerful "); + println!("!!!!! and flexible new app creator for Loco. To install the new CLI run:"); + println!("!!!!!"); + println!("!!!!! $ cargo uninstall loco-cli && cargo install loco"); + println!("!!!!!"); + println!(""); + println!(""); + println!(""); let cli = Cli::parse(); tracing_subscriber::fmt() diff --git a/loco-gen/src/model.rs b/loco-gen/src/model.rs index 0d70c1100..0e1a74041 100644 --- a/loco-gen/src/model.rs +++ b/loco-gen/src/model.rs @@ -108,22 +108,20 @@ mod tests { where F: FnOnce(), { - testutil::with_temp_dir(|previous, current| { + testutil::with_temp_dir(|_previous, current| { let status = Command::new("loco") .args([ "new", "-n", app_name, - "-t", - "saas", "--db", "sqlite", "--bg", "async", "--assets", "serverside", + "-a", ]) - .env("STARTERS_LOCAL_PATH", previous.join("../")) .status() .expect("cannot run command"); diff --git a/loco-new/Cargo.toml b/loco-new/Cargo.toml new file mode 100644 index 000000000..f2f71e97c --- /dev/null +++ b/loco-new/Cargo.toml @@ -0,0 +1,52 @@ +[package] +name = "loco" +version = "0.2.10" +edition = "2021" +description = "Loco new app generator" +license = "Apache-2.0" +homepage = "https://docs.rs/loco" +documentation = "https://docs.rs/loco" +authors = ["Dotan Nahum
+ + find this tera template at
assets/views/home/hello.html:
+ +
+ {{ t(key="hello-world", lang="en-US") }}, +
+ {{ t(key="hello-world", lang="de-DE") }} + + + \ No newline at end of file diff --git a/loco-new/base_template/config/development.yaml.t b/loco-new/base_template/config/development.yaml.t new file mode 100644 index 000000000..44ba73f03 --- /dev/null +++ b/loco-new/base_template/config/development.yaml.t @@ -0,0 +1,129 @@ +# Loco configuration file documentation + +# Application logging configuration +logger: + # Enable or disable logging. + enable: true + # Enable pretty backtrace (sets RUST_BACKTRACE=1) + pretty_backtrace: true + # Log level, options: trace, debug, info, warn or error. + level: debug + # Define the logging format. options: compact, pretty or json + format: compact + # By default the logger has filtering only logs that came from your code or logs that came from `loco` framework. to see all third party libraries + # Uncomment the line below to override to see all third party libraries you can enable this config and override the logger filters. + # override_filter: trace + +# Web server configuration +server: + # Port on which the server will listen. the server binding is 0.0.0.0:{PORT} + port: 5150 + # The UI hostname or IP address that mailers will point to. + host: http://localhost + # Out of the box middleware configuration. to disable middleware you can changed the `enable` field to `false` of comment the middleware block + middlewares: + {%- if settings.asset %} + {%- if settings.asset.kind == "server" %} + static: + enable: true + must_exist: true + precompressed: false + folder: + uri: "/static" + path: "assets/static" + fallback: "assets/static/404.html" + {%- elif settings.asset.kind == "client" %} + static: + enable: true + must_exist: true + precompressed: false + folder: + uri: "/" + path: "frontend/dist" + fallback: "frontend/dist/index.html" + {%- endif -%} + + {%- endif -%} + +{%- if settings.background%} + +# Worker Configuration +workers: + # specifies the worker mode. Options: + # - BackgroundQueue - Workers operate asynchronously in the background, processing queued. + # - ForegroundBlocking - Workers operate in the foreground and block until tasks are completed. + # - BackgroundAsync - Workers operate asynchronously in the background, processing tasks with async capabilities. + mode: {{settings.background.kind}} + + {% if settings.background.kind == "BackgroundQueue"%} +# Queue Configuration +queue: + kind: Redis + # Redis connection URI + uri: {% raw %}{{{% endraw %} get_env(name="REDIS_URL", default="redis://127.0.0.1") {% raw %}}}{% endraw %} + # Dangerously flush all data in Redis on startup. dangerous operation, make sure that you using this flag only on dev environments or test mode + dangerously_flush: false + {%- endif %} +{%- endif -%} + +{%- if settings.mailer %} + +# Mailer Configuration. +mailer: + # SMTP mailer configuration. + smtp: + # Enable/Disable smtp mailer. + enable: true + # SMTP server host. e.x localhost, smtp.gmail.com + host: {{ get_env(name="MAILER_HOST", default="localhost") }} + # SMTP server port + port: 1025 + # Use secure connection (SSL/TLS). + secure: false + # auth: + # user: + # password: +{%- endif %} + +# Initializers Configuration +# initializers: +# oauth2: +# authorization_code: # Authorization code grant type +# - client_identifier: google # Identifier for the OAuth2 provider. Replace 'google' with your provider's name if different, must be unique within the oauth2 config. +# ... other fields + +{%- if settings.db %} + +# Database Configuration +database: + # Database connection URI + uri: {% raw %}{{{% endraw %} get_env(name="DATABASE_URL", default="{{settings.db.endpoint}}") {% raw %}}}{% endraw %} + # When enabled, the sql query will be logged. + enable_logging: false + # Set the timeout duration when acquiring a connection. + connect_timeout: {% raw %}{{{% endraw %} get_env(name="DB_CONNECT_TIMEOUT", default="500") {% raw %}}}{% endraw %} + # Set the idle duration before closing a connection. + idle_timeout: {% raw %}{{{% endraw %} get_env(name="DB_IDLE_TIMEOUT", default="500") {% raw %}}}{% endraw %} + # Minimum number of connections for a pool. + min_connections: {% raw %}{{{% endraw %} get_env(name="DB_MIN_CONNECTIONS", default="1") {% raw %}}}{% endraw %} + # Maximum number of connections for a pool. + max_connections: {% raw %}{{{% endraw %} get_env(name="DB_MAX_CONNECTIONS", default="1") {% raw %}}}{% endraw %} + # Run migration up when application loaded + auto_migrate: true + # Truncate database when application loaded. This is a dangerous operation, make sure that you using this flag only on dev environments or test mode + dangerously_truncate: false + # Recreating schema when application loaded. This is a dangerous operation, make sure that you using this flag only on dev environments or test mode + dangerously_recreate: false +{%- endif %} + +{%- if settings.auth %} + +# Authentication Configuration +auth: + # JWT authentication + jwt: + # Secret key for token generation and verification + secret: {{20 | random_string }} + # Token expiration time in seconds + expiration: 604800 # 7 days +{%- endif %} diff --git a/loco-new/base_template/config/production.yaml b/loco-new/base_template/config/production.yaml new file mode 100644 index 000000000..e69de29bb diff --git a/loco-new/base_template/config/test.yaml.t b/loco-new/base_template/config/test.yaml.t new file mode 100644 index 000000000..dcc902fc7 --- /dev/null +++ b/loco-new/base_template/config/test.yaml.t @@ -0,0 +1,129 @@ +# Loco configuration file documentation + +# Application logging configuration +logger: + # Enable or disable logging. + enable: false + # Enable pretty backtrace (sets RUST_BACKTRACE=1) + pretty_backtrace: true + # Log level, options: trace, debug, info, warn or error. + level: debug + # Define the logging format. options: compact, pretty or json + format: compact + # By default the logger has filtering only logs that came from your code or logs that came from `loco` framework. to see all third party libraries + # Uncomment the line below to override to see all third party libraries you can enable this config and override the logger filters. + # override_filter: trace + +# Web server configuration +server: + # Port on which the server will listen. the server binding is 0.0.0.0:{PORT} + port: 5150 + # The UI hostname or IP address that mailers will point to. + host: http://localhost + # Out of the box middleware configuration. to disable middleware you can changed the `enable` field to `false` of comment the middleware block + middlewares: + {%- if settings.asset %} + {%- if settings.asset.kind == "server" %} + static: + enable: true + must_exist: true + precompressed: false + folder: + uri: "/static" + path: "assets/static" + fallback: "assets/static/404.html" + {%- elif settings.asset.kind == "client" %} + static: + enable: true + must_exist: true + precompressed: false + folder: + uri: "/" + path: "frontend/dist" + fallback: "frontend/dist/index.html" + {%- endif -%} + + {%- endif -%} + +{%- if settings.background%} + +# Worker Configuration +workers: + # specifies the worker mode. Options: + # - BackgroundQueue - Workers operate asynchronously in the background, processing queued. + # - ForegroundBlocking - Workers operate in the foreground and block until tasks are completed. + # - BackgroundAsync - Workers operate asynchronously in the background, processing tasks with async capabilities. + mode: {{settings.background.kind}} + + {% if settings.background.kind == "BackgroundQueue"%} +# Queue Configuration +queue: + kind: Redis + # Redis connection URI + uri: {% raw %}{{{% endraw %} get_env(name="REDIS_URL", default="redis://127.0.0.1") {% raw %}}}{% endraw %} + # Dangerously flush all data in Redis on startup. dangerous operation, make sure that you using this flag only on dev environments or test mode + dangerously_flush: false + {%- endif %} +{%- endif -%} + +{%- if settings.mailer %} + +# Mailer Configuration. +mailer: + # SMTP mailer configuration. + smtp: + # Enable/Disable smtp mailer. + enable: true + # SMTP server host. e.x localhost, smtp.gmail.com + host: {{ get_env(name="MAILER_HOST", default="localhost") }} + # SMTP server port + port: 1025 + # Use secure connection (SSL/TLS). + secure: false + # auth: + # user: + # password: +{%- endif %} + +# Initializers Configuration +# initializers: +# oauth2: +# authorization_code: # Authorization code grant type +# - client_identifier: google # Identifier for the OAuth2 provider. Replace 'google' with your provider's name if different, must be unique within the oauth2 config. +# ... other fields + +{%- if settings.db %} + +# Database Configuration +database: + # Database connection URI + uri: {% raw %}{{{% endraw %} get_env(name="DATABASE_URL", default="{{settings.db.endpoint}}") {% raw %}}}{% endraw %} + # When enabled, the sql query will be logged. + enable_logging: false + # Set the timeout duration when acquiring a connection. + connect_timeout: {% raw %}{{{% endraw %} get_env(name="DB_CONNECT_TIMEOUT", default="500") {% raw %}}}{% endraw %} + # Set the idle duration before closing a connection. + idle_timeout: {% raw %}{{{% endraw %} get_env(name="DB_IDLE_TIMEOUT", default="500") {% raw %}}}{% endraw %} + # Minimum number of connections for a pool. + min_connections: {% raw %}{{{% endraw %} get_env(name="DB_MIN_CONNECTIONS", default="1") {% raw %}}}{% endraw %} + # Maximum number of connections for a pool. + max_connections: {% raw %}{{{% endraw %} get_env(name="DB_MAX_CONNECTIONS", default="1") {% raw %}}}{% endraw %} + # Run migration up when application loaded + auto_migrate: true + # Truncate database when application loaded. This is a dangerous operation, make sure that you using this flag only on dev environments or test mode + dangerously_truncate: true + # Recreating schema when application loaded. This is a dangerous operation, make sure that you using this flag only on dev environments or test mode + dangerously_recreate: false +{%- endif %} + +{%- if settings.auth %} + +# Authentication Configuration +auth: + # JWT authentication + jwt: + # Secret key for token generation and verification + secret: {{20 | random_string }} + # Token expiration time in seconds + expiration: 604800 # 7 days +{%- endif %} diff --git a/loco-new/base_template/examples/playground.rs.t b/loco-new/base_template/examples/playground.rs.t new file mode 100644 index 000000000..2a2c362fd --- /dev/null +++ b/loco-new/base_template/examples/playground.rs.t @@ -0,0 +1,21 @@ +#[allow(unused_imports)] +use loco_rs::{cli::playground, prelude::*}; +use {{settings.module_name}}::app::App; + +#[tokio::main] +async fn main() -> loco_rs::Result<()> { + let _ctx = playground::
+ The Loco Team + + + diff --git a/loco-new/base_template/src/mailers/auth/forgot/subject.t b/loco-new/base_template/src/mailers/auth/forgot/subject.t new file mode 100644 index 000000000..4938df1e3 --- /dev/null +++ b/loco-new/base_template/src/mailers/auth/forgot/subject.t @@ -0,0 +1 @@ +Your reset password link diff --git a/loco-new/base_template/src/mailers/auth/forgot/text.t b/loco-new/base_template/src/mailers/auth/forgot/text.t new file mode 100644 index 000000000..58c30fd8d --- /dev/null +++ b/loco-new/base_template/src/mailers/auth/forgot/text.t @@ -0,0 +1,3 @@ +Reset your password with this link: + +http://localhost/reset#{{resetToken}} diff --git a/loco-new/base_template/src/mailers/auth/welcome/html.t b/loco-new/base_template/src/mailers/auth/welcome/html.t new file mode 100644 index 000000000..ae4c41c65 --- /dev/null +++ b/loco-new/base_template/src/mailers/auth/welcome/html.t @@ -0,0 +1,13 @@ +; + + + Dear {{name}}, + Welcome to Loco! You can now log in to your account. + Before you get started, please verify your account by clicking the link below: + + Verify Your Account + +
Best regards,
The Loco Team