Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/SuperPaintman/serve
Command line static HTTP server
https://github.com/SuperPaintman/serve
server static-server
Last synced: about 1 month ago
JSON representation
Command line static HTTP server
- Host: GitHub
- URL: https://github.com/SuperPaintman/serve
- Owner: SuperPaintman
- License: mit
- Created: 2016-11-13T11:41:16.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2017-03-22T12:00:25.000Z (over 7 years ago)
- Last Synced: 2024-08-01T17:36:56.971Z (4 months ago)
- Topics: server, static-server
- Language: Crystal
- Size: 123 KB
- Stars: 23
- Watchers: 5
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-crystal - serve - Command line static HTTP server (Web Servers)
- awesome-crystal - serve - Command line static HTTP server (Web Servers)
README
# Serve
[![Linux Build][travis-image]][travis-url]
[![Shards version][shards-image]][shards-url]
Command line static HTTP server
![Screenshot][screenshot-image]
## Installation
Download from **github**:
```sh
$ serve_version="0.1.1"
$ serve_arch="x86_64"
$ curl -Lo /usr/local/bin/serve.gz "https://github.com/SuperPaintman/serve/releases/download/v${serve_version}/serve-${serve_version}_linux_${serve_arch}.gz"
$ gunzip /usr/local/bin/serve.gz
$ chmod +x /usr/local/bin/serve
```
From sources:
```sh
$ cd ~/Projects
$ git clone https://github.com/SuperPaintman/serve
$ cd ./serve
$ make
$ sudo make install
$ # or
$ sudo make reinstall
```
--------------------------------------------------------------------------------
## Usage
```sh
$ serve -h
```
--------------------------------------------------------------------------------
## Test
```sh
$ crystal spec
# or
$ make test
```
--------------------------------------------------------------------------------
## Shell tab auto-completion
To enable tab auto-completion for **Serve**, add one of the following lines
to your `~/.zshrc` file.
```sh
# Zsh, ~/.zshrc
if [[ -z $commands[serve] ]]; then
echo 'serve is not installed, you should install it first'
else
eval "$(serve --completion=zsh)"
fi
```
--------------------------------------------------------------------------------
## Contributing
1. Fork it ()
2. Create your feature branch (`git checkout -b feature/`)
3. Commit your changes (`git commit -am 'Added some feature'`)
4. Push to the branch (`git push origin feature/`)
5. Create a new Pull Request
--------------------------------------------------------------------------------
## Contributors
- [SuperPaintman](https://github.com/SuperPaintman) SuperPaintman - creator, maintainer
--------------------------------------------------------------------------------
## API
[Docs][docs-url]
--------------------------------------------------------------------------------
## Changelog
[Changelog][changelog-url]
--------------------------------------------------------------------------------
## License
[MIT][license-url]
[license-url]: LICENSE
[changelog-url]: CHANGELOG.md
[docs-url]: https://superpaintman.github.io/serve/
[screenshot-image]: README/screenshot.png
[travis-image]: https://img.shields.io/travis/SuperPaintman/serve/master.svg?label=linux
[travis-url]: https://travis-ci.org/SuperPaintman/serve
[shards-image]: https://img.shields.io/github/tag/superpaintman/serve.svg?label=shards
[shards-url]: https://github.com/superpaintman/serve