https://github.com/dalgona/microscope

A simple static web server based on cowboy
https://github.com/dalgona/microscope

Last synced: about 15 hours ago
JSON representation

A simple static web server based on cowboy

• Host: GitHub
• URL: https://github.com/dalgona/microscope
• Owner: Dalgona
• License: mit
• Created: 2016-12-20T13:21:35.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2021-01-01T03:32:46.000Z (almost 4 years ago)
• Last Synced: 2024-11-06T18:01:27.837Z (10 days ago)
• Language: Elixir
• Size: 69.3 KB
• Stars: 15
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Microscope

[Microscope on hex.pm](https://hex.pm/packages/microscope)

[Official documentation](https://hexdocs.pm/microscope)

Microscope is a simple static web server written in [Elixir](http://elixir-lang.org)

using [cowboy](https://hex.pm/packages/cowboy).

Originally it was a part of [Serum](http://dalgona.hontou.moe/Serum) development

server, but I decided to separate into the other project for better

maintainability. Now it became a general purpose static web server suitable

for testing your static websites or quickly sharing your files over HTTP.

## Installation

Add `microscope` to your list of dependencies in `mix.exs`:

```elixir

def deps do

  [{:microscope, "~> 1.0"}]

end

```

## Using Microscope

### Using in Your Module

Start Microscope using `Microscope.start_link/3`.

```elixir

{:ok, pid} =

  Microscope.start_link("/home/user/www", [base: "/base/url", port: 8080])

```

The server will start listening on port `8080`. Open a web browser and navigate

to `http://:8080/base/url/path/to/file`, and the contents of

`/home/user/www/path/to/file` will be displayed.

You may request either a file or a directory. If you request a file, Microscope

will try to serve the requested file, or respond with HTTP 404 if the file does

not exist. And if you request a directory, Microscope will look for `index.html`

or `index.htm` inside the requested directory and serve one if found.

### As a Command-line Application

Microscope also comes with a Mix task which provides a way to launch a static

web server right away.

For example, suppose you have generated docs for your project with ExDoc, and

you want to see them before publishing to Hex. Then, simply type the command

below:

```

% mix microscope doc

```

Now open a web browser and navigate to `http://:8080/` to see the

docs. Easy and real quick! :rocket:

Type `mix microscope` on your shell to see all possible startup options.

## License

MIT. Please read `LICENSE` file for the full text.