1 | # casket
|
2 |
|
3 | ***casket* is an HTTP server** that supports `GET`, `POST` and `DELETE` requests. It can respond in HTML, JSON and plain text format, the HTML-version being a minimalistic file management UI. It is perfect for small home-server setups and offline collaboration, kind of like a very, very small Dropbox.
|
4 |
|
5 | *casket* is written in CoffeeScript and embraces [prototypal programming](http://davidwalsh.name/javascript-objects-deconstruction#simpler-object-object), making it easily extendable. ***casket* is [MIT-licensed](LICENSE).**
|
6 |
|
7 | [![npm version](https://img.shields.io/npm/v/casket.svg)](https://www.npmjs.com/package/casket)
|
8 | [![dependency status](https://img.shields.io/david/derhuerst/casket.svg)](https://david-dm.org/derhuerst/casket)
|
9 |
|
10 |
|
11 |
|
12 | ## Install (globally)
|
13 |
|
14 | ```shell
|
15 | npm install -g casket
|
16 | ```
|
17 |
|
18 | You can now start *casket* whereever you want.
|
19 |
|
20 |
|
21 |
|
22 | ## Usage
|
23 |
|
24 | ```shell
|
25 | casket # run casket in "live mode"
|
26 | ```
|
27 |
|
28 | or
|
29 |
|
30 | ```shell
|
31 | casketd # run casket in the background
|
32 | ```
|
33 |
|
34 |
|
35 | ### `casket`
|
36 |
|
37 | ```
|
38 | casket [-n <name>] [-d <directory>] [-p <port>]
|
39 |
|
40 | Options:
|
41 | -n, --name How the casket server will call itself. Default: casket
|
42 | -d, --dir What casket server will serve. Default: ./public
|
43 | -p, --port Where the casket server will listen. Default: 8000%
|
44 | ```
|
45 |
|
46 |
|
47 | ### `casketd`
|
48 |
|
49 | ```
|
50 | casketd start <name> [-d <directory>] [-p <port>]
|
51 | casketd stop <name>
|
52 |
|
53 | Arguments:
|
54 | name How the casket server will call itself.
|
55 |
|
56 | Options:
|
57 | -d, --dir What casket server will serve. Default: ./public
|
58 | -p, --port Where the casket server will listen. Default: 8000
|
59 | ```
|
60 |
|
61 |
|
62 |
|
63 | ## Documentation
|
64 |
|
65 | coming soon!
|
66 |
|
67 |
|
68 |
|
69 | ## Contributing
|
70 |
|
71 | If you **have a question**, **found a bug** or want to **propose a feature**, have a look at [the issues page](https://github.com/derhuerst/casket/issues).
|