https://github.com/raphamorim/cargo-server

serve a static site, single page application or just a static file with Rust
https://github.com/raphamorim/cargo-server

file-server rust-lang server simple-server static-site

Last synced: 2 days ago
JSON representation

serve a static site, single page application or just a static file with Rust

• Host: GitHub
• URL: https://github.com/raphamorim/cargo-server
• Owner: raphamorim
• License: mpl-2.0
• Created: 2022-08-28T11:58:01.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2023-11-12T00:02:27.000Z (12 months ago)
• Last Synced: 2024-10-23T17:19:00.438Z (11 days ago)
• Topics: file-server, rust-lang, server, simple-server, static-site
• Language: Rust
• Homepage: https://crates.io/crates/cargo-server
• Size: 832 KB
• Stars: 26
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
# cargo-server

> tl;dr: Does the same as "python -m http.server" or "npx serve" but for Rust ecosystem and with few more functionalities.

`cargo-server` helps you serve a static site, single page application or just a static file (no matter if on your device or on the local network). It also provides a neat interface for listing the directory's contents.

You can use cargo to install:

```bash

cargo install cargo-server

```

With cargo-binstall:

```bash

cargo binstall cargo-server

```

Once `cargo-server` is installed, you can run this command inside your project's directory. It will create by default in `8000` port:

```bash

cargo server

```

## --port

To specify the port, you can use `--port`:

```bash

cargo server --port 3000

```

## --open

To open in your browser after run the command just add `--open`:

```bash

cargo server --open

```

## --path

You can also set a custom path using `--path`:

```bash

cargo server --path ./examples/simple-wasm-frontend-app

```

Result:

![Demo](resources/demo-file-server.png)

## --quiet

Is also possible to run without any stdout using `--quiet`:

```bash

cargo server --quiet --open --path ./examples/simple-wasm-frontend-app

```

## --route

You can create custom routes that returns JSON

#### `--json` with params

```bash

cargo server \

	--route '/users/:userId' \

	--json '{"data":{"userId":"{!0}","givenName":"Raphael","country":"br"}}' \

	--port 8123

```

Result:

![Demo JSON with params](resources/demo-json-with-params.png)

#### `--json` without params

```bash

cargo server \

	--route '/users' \

	--json '{"users":[{"data":{"userId":"3","givenName":"Raphael","country":"br"}}]}' \

	--port 8123

```

Result:

![Demo JSON](resources/demo-json.png)

#### `--all-routes`

It will add support for GET, POST, DELETE and PATCH methods as well.

```bash

cargo server \

	--all-routes \

	--json '{"id": "1"}' \

	--port 8123

```

Result:

![Demo JSON all routes](resources/demo-all-routes.png)

## --ngnix

In progress...