Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update starters readme.md #767

Merged
merged 1 commit into from
Sep 22, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 12 additions & 4 deletions starters/lightweight-service/README.md
Original file line number Diff line number Diff line change
@@ -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`
Expand All @@ -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
Expand Down
27 changes: 13 additions & 14 deletions starters/rest-api/README.md
Original file line number Diff line number Diff line change
@@ -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 <code>loco:loco</code> and a db named <code>[app name]_development.</code>:
> <code>docker run -d -p 5432:5432 -e POSTGRES_USER=loco -e POSTGRES_DB=[app name]_development -e POSTGRES_PASSWORD="loco" postgres:15.3-alpine</code>

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`
Expand All @@ -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
Expand Down
27 changes: 13 additions & 14 deletions starters/saas/README.md
Original file line number Diff line number Diff line change
@@ -1,26 +1,18 @@
# 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.


## 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 <code>loco:loco</code> and a db named <code>[app name]_development.</code>:
<code>docker run -d -p 5432:5432 -e POSTGRES_USER=loco -e POSTGRES_DB=[app name]_development -e POSTGRES_PASSWORD="loco" postgres:15.3-alpine</code>

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`
Expand All @@ -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
Expand Down
Loading