3wordchant
/
oasis
0
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
Mirror of https://github.com/fraction/oasis.git to build Docker images 🙈
447 Commits 18 Branches 98 Tags 7.5 MiB
JavaScript 90.8%
CSS 7%
Go 1%
Shell 0.9%
Dockerfile 0.3%
Go to file
Christian Bundy cb4a6ef971 2.11.0 2020-01-16 11:58:00 -08:00
.github Change issue template to be less annoying 2020-01-08 08:04:42 -08:00
contrib fix docker file now that server.js is gone 2020-01-11 22:46:57 +00:00
docs Add documentation on new layer style 2020-01-09 09:35:39 -08:00
scripts Add release script 2019-12-29 13:51:57 -08:00
src Merge branch 'master' into follow-unfollow 2020-01-14 08:54:08 -08:00
.cspell.json Add install-systemd-service.js 2020-01-03 21:06:08 -08:00
.dockerignore Add support for running oasis in a docker container 2020-01-01 10:07:41 -05:00
.gitignore Replace yarn.lock with package-lock.json 2020-01-03 15:19:35 -08:00
.huskyrc Fix Travis CI on Windows 2019-09-16 15:50:03 -07:00
.npmignore Add npmignore 2019-10-31 15:25:05 -07:00
.stylelintrc Add stylelint-config-standard for more opinionated CSS 2019-09-25 19:07:38 -07:00
.travis.yml Add Travis CI cache back 2019-09-17 16:11:55 -07:00
CHANGELOG.md 2.11.0 2020-01-16 11:58:00 -08:00
README.md Update README.md to include --offline in CLI help 2020-01-07 13:29:08 -08:00
package-lock.json 2.11.0 2020-01-16 11:58:00 -08:00
package.json 2.11.0 2020-01-16 11:58:00 -08:00

README.md

Oasis

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 some extra tools for debugging, not to support all known message types.

Usage

$ oasis --help

Usage: oasis [options]

Options:
  --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]
  --debug     Use verbose output for debugging        [boolean] [default: false]

Installation

Most people should install Oasis with npm.

npm --global install @fraction/oasis@latest

Want more? Check out install.md.

Resources

See Also

License

AGPL-3.0