2019-06-24 19:19:06 +00:00
|
|
|
# Oasis
|
|
|
|
|
|
2019-08-08 17:39:22 +00:00
|
|
|
**Friendly Scuttlebutt interface designed for simplicity and accessibility.**
|
|
|
|
|
This is an experimental client built with HTML, CSS, and Node.js without any
|
|
|
|
|
front-end JavaScript. The goal is to support basic social messaging schemas with
|
2020-01-03 23:04:16 +00:00
|
|
|
some extra tools for debugging, _not_ to support all known message types.
|
2019-06-24 19:19:06 +00:00
|
|
|
|
|
|
|
|
## Usage
|
|
|
|
|
|
2019-08-08 17:39:22 +00:00
|
|
|
```console
|
|
|
|
|
$ oasis --help
|
2020-01-07 21:29:08 +00:00
|
|
|
|
2019-08-08 17:39:22 +00:00
|
|
|
Usage: oasis [options]
|
|
|
|
|
|
|
|
|
|
Options:
|
2020-01-07 21:29:08 +00:00
|
|
|
--version Show version number [boolean]
|
|
|
|
|
-h, --help Show help [boolean]
|
|
|
|
|
--open Automatically open app in web browser. Use --no-open to disable.
|
|
|
|
|
[boolean] [default: true]
|
|
|
|
|
--offline Don't try to connect to scuttlebutt peers or pubs
|
|
|
|
|
[boolean] [default: false]
|
|
|
|
|
--host Hostname for web app to listen on [string] [default: "localhost"]
|
|
|
|
|
--port Port for web app to listen on [number] [default: 3000]
|
2020-01-22 00:22:19 +00:00
|
|
|
--debug Use verbose output for debugging [boolean] [default: false]
|
2019-06-24 19:19:06 +00:00
|
|
|
```
|
|
|
|
|
|
|
|
|
|
## Installation
|
|
|
|
|
|
2020-01-03 23:04:16 +00:00
|
|
|
Most people should install Oasis with [npm](https://npmjs.org/).
|
2019-06-24 19:19:06 +00:00
|
|
|
|
|
|
|
|
```shell
|
2020-01-03 23:04:16 +00:00
|
|
|
npm --global install @fraction/oasis@latest
|
2019-06-24 19:19:06 +00:00
|
|
|
```
|
|
|
|
|
|
2020-01-03 23:04:16 +00:00
|
|
|
Want more? Check out [`install.md`](https://github.com/fraction/oasis/blob/master/docs/install.md).
|
2020-01-03 20:03:21 +00:00
|
|
|
|
2019-09-24 21:21:28 +00:00
|
|
|
## Resources
|
|
|
|
|
|
|
|
|
|
- [Contributing](https://github.com/fraction/oasis/blob/master/docs/contributing.md)
|
|
|
|
|
- [Help](https://github.com/fraction/oasis/issues/new/choose)
|
|
|
|
|
- [Roadmap](https://github.com/fraction/oasis/blob/master/docs/roadmap.md)
|
|
|
|
|
- [Security Policy](https://github.com/fraction/oasis/blob/master/docs/security.md)
|
|
|
|
|
- [Source Code](https://github.com/fraction/oasis.git)
|
|
|
|
|
|
2019-06-24 19:19:06 +00:00
|
|
|
## See Also
|
|
|
|
|
|
|
|
|
|
- [patchbay](https://github.com/ssbc/patchbay)
|
|
|
|
|
- [patchwork](https://github.com/ssbc/patchwork)
|
2019-09-24 19:37:12 +00:00
|
|
|
- [ssb-browser-demo](https://github.com/arj03/ssb-browser-demo)
|
2019-06-24 19:19:06 +00:00
|
|
|
- [ssb-server](https://github.com/ssbc/ssb-server)
|
|
|
|
|
- [yap](https://github.com/dominictarr/yap)
|
|
|
|
|
|
|
|
|
|
## License
|
|
|
|
|
|
2019-09-27 00:19:18 +00:00
|
|
|
AGPL-3.0
|
