http-server 1.0.0-pre.6fa7635

Simple and configurable command-line HTTP server
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86

<div>
  <div align="center" style="display: block; text-align: center;">
    <img src="https://avatars.githubusercontent.com/u/122044824?s=400&u=a90857a96069dbb669412b1bbca8ef6757610d9c&v=4" height="120" width="120" />
  </div>
  <h1 align="center">http-server</h1>
  <h4 align="center">Simple and configurable command-line HTTP server</h4>
</div>

<div align="center">

[![Crates.io](https://img.shields.io/crates/v/http-server.svg)](https://crates.io/crates/http-server)
[![Documentation](https://docs.rs/http-server/badge.svg)](https://docs.rs/http-server)
![Build](https://github.com/http-server-rs/http-server/workflows/build/badge.svg)
![Clippy](https://github.com/http-server-rs/http-server/workflows/clippy/badge.svg)
![Formatter](https://github.com/http-server-rs/http-server/workflows/fmt/badge.svg)
![Tests](https://github.com/http-server-rs/http-server/workflows/test/badge.svg)

</div>

## Development

> [!NOTE]
> The source code in `main` belongs to the code for the version `1.0.0`.

### Release Build

Build release binaries with:

```bash
make release
```

Optionally you can build for other targets by specifying the `TARGET` variable

```bash
make release TARGET=<target-triple>
```

For example:

```bash
# Install aarch64-unknown-linux-gnu target
rustup target install aarch64-unknown-linux-gnu
# Build for aarch64-unknown-linux-gnu target
make release TARGET=aarch64-unknown-linux-gnu
```

Then use the following _alias_ for convenience

```bash
alias htps = './target/release/http-server'
```

## Release

In order to create a release you must push a Git tag as follows

```sh
git tag -a <version> -m <message>
```

**Example**

```sh
git tag -a v0.1.0 -m "First release"
```

> Tags must follow semver conventions.
> Tags must be prefixed with a lowercase `v` letter.

Then push tags as follows:

```sh
git push origin main --follow-tags
```

## Contributing

Every contribution to this project is welcome. Feel free to open a pull request or
an issue. Just by using this project you're helping it grow. Thank you!

## License

Distributed under the terms of both the MIT license and the Apache License (Version 2.0)

[1]: https://github.com/http-server-rs/http-server