Installation
Check for the installation to be successful.
Usage
http-server [FLAGS] [OPTIONS] [root_dir]
Flags
Flags are provided without any values. For example:
http-server --help
| Name | Short | Long | Description |
|---|---|---|---|
| Help | N/A | --help |
Prints help information |
| Version | -V |
--version |
Prints version information |
| Verbose | -v |
--verbose |
Prints output to console |
Options
Options receives a value and have support for default values as well.
http-server --host 127.0.0.1
| Name | Short | Long | Description | Default Value |
|---|---|---|---|---|
| Host | -h |
--host |
Address to bind the server | 127.0.0.1 |
| Port | -p |
--port |
Port to bind the server | 7878 |
| Configuration File | -c |
--config |
Specifies a configuration file. Example | N/A |
Release
In order to create a release you must push a Git tag as follows
git tag -a <version> -m <message>
Example
git tag -a v0.1.0 -m "First release"
Tags must follow semver conventions Tags must be prefixed with a lowercase
vletter.
Then push tags as follows:
git push origin main --follow-tags
Contributing
Every contribution to this project is welcome. Feel free to open a pull request, an issue or just by starting this project.
License
Distributed under the terms of both the MIT license and the Apache License (Version 2.0)
Contribution
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in http-server by you, shall be dual licensed as above, without any additional terms or conditions.