diff --git a/starters/lightweight-service/README.md b/starters/lightweight-service/README.md index af1302c2f..302acc3e6 100644 --- a/starters/lightweight-service/README.md +++ b/starters/lightweight-service/README.md @@ -1,14 +1,16 @@ # Welcome to Loco :train: -Loco is a web and API framework running on Rust. +[Loco](https://loco.rs) is a web and API framework running on Rust. This is the **lightweight-service starter** which comes with no database or state dependencies. ## Quick Start -Start your app: - +```sh +cargo loco start ``` + +```sh $ cargo loco start Finished dev [unoptimized + debuginfo] target(s) in 21.63s Running `target/debug/myapp start` @@ -33,8 +35,14 @@ controller/app_routes.rs:203: [Middleware] Adding log trace id ██████ █████ ███ ████ ███ █████ ███ ████▀ ▀▀▀██▄ ▀▀▀▀▀▀▀▀▀▀ ▀▀▀▀▀▀▀▀▀▀ ▀▀▀▀▀▀▀▀▀▀ ██▀ ▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀ + https://loco.rs + +environment: development + logger: debug +compilation: debug + modes: server -started on port 5150 +listening on localhost:5150 ``` ## Getting help diff --git a/starters/rest-api/README.md b/starters/rest-api/README.md index 380f1315b..74f1ff01d 100644 --- a/starters/rest-api/README.md +++ b/starters/rest-api/README.md @@ -1,24 +1,16 @@ # Welcome to Loco :train: -Loco is a web and API framework running on Rust. +[Loco](https://loco.rs) is a web and API framework running on Rust. This is the **Rest API starter** which includes a `User` model and authentication based on JWT. ## Quick Start -You need: - -- A local postgres instance -- A local Redis instance - -Check out your development [configuration](config/development.yaml). - -> To configure a database , please run a local postgres database with loco:loco and a db named [app name]_development.: -> docker run -d -p 5432:5432 -e POSTGRES_USER=loco -e POSTGRES_DB=[app name]_development -e POSTGRES_PASSWORD="loco" postgres:15.3-alpine - -Now start your app: - +```sh +cargo loco start ``` + +```sh $ cargo loco start Finished dev [unoptimized + debuginfo] target(s) in 21.63s Running `target/debug/myapp start` @@ -43,8 +35,15 @@ controller/app_routes.rs:203: [Middleware] Adding log trace id ██████ █████ ███ ████ ███ █████ ███ ████▀ ▀▀▀██▄ ▀▀▀▀▀▀▀▀▀▀ ▀▀▀▀▀▀▀▀▀▀ ▀▀▀▀▀▀▀▀▀▀ ██▀ ▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀ + https://loco.rs + +environment: development + database: automigrate + logger: debug +compilation: debug + modes: server -started on port 5150 +listening on localhost:5150 ``` ## Getting help diff --git a/starters/saas/README.md b/starters/saas/README.md index acaf0e12c..816ed4707 100644 --- a/starters/saas/README.md +++ b/starters/saas/README.md @@ -1,6 +1,6 @@ # Welcome to Loco :train: -Loco is a web and API framework running on Rust. +[Loco](https://loco.rs) is a web and API framework running on Rust. This is the **SaaS starter** which includes a `User` model and authentication based on JWT. It also include configuration sections that help you pick either a frontend or a server-side template set up for your fullstack server. @@ -8,19 +8,11 @@ It also include configuration sections that help you pick either a frontend or a ## Quick Start -You need: - -* A local postgres instance -* A local Redis instance - -Check out your development [configuration](config/development.yaml). - -> To configure a database , please run a local postgres database with loco:loco and a db named [app name]_development.: -docker run -d -p 5432:5432 -e POSTGRES_USER=loco -e POSTGRES_DB=[app name]_development -e POSTGRES_PASSWORD="loco" postgres:15.3-alpine - -Now start your app: - +```sh +cargo loco start ``` + +```sh $ cargo loco start Finished dev [unoptimized + debuginfo] target(s) in 21.63s Running `target/debug/myapp start` @@ -45,8 +37,15 @@ controller/app_routes.rs:203: [Middleware] Adding log trace id ██████ █████ ███ ████ ███ █████ ███ ████▀ ▀▀▀██▄ ▀▀▀▀▀▀▀▀▀▀ ▀▀▀▀▀▀▀▀▀▀ ▀▀▀▀▀▀▀▀▀▀ ██▀ ▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀ + https://loco.rs + +environment: development + database: automigrate + logger: debug +compilation: debug + modes: server -started on port 5150 +listening on localhost:5150 ``` ## Full Stack Serving