Mirror of https://github.com/fraction/oasis.git to build Docker images 🙈

browser css html javascript nodejs p2p scuttlebutt ssb

Go to file

Christian Bundy ff54db563a Merge pull request #132 from fraction/no-follow-yourself Remove follow button from your own profile		2020-01-31 21:05:54 -08:00
.github	fix typo in github issue template	2020-01-28 22:18:52 -05:00
contrib	Experiment with common-good module	2020-01-21 16:22:19 -08:00
docs	Replace "must" with "shall" in contributing.md	2020-01-30 09:12:58 -08:00
scripts	Add release script	2019-12-29 13:51:57 -08:00
src	Merge pull request #132 from fraction/no-follow-yourself	2020-01-31 21:05:54 -08:00
.cspell.json	add upstream C4/42 contributing document	2020-01-28 14:33:05 -05:00
.dockerignore	Add support for running oasis in a docker container	2020-01-01 10:07:41 -05:00
.eslintrc.js	Experiment with common-good module	2020-01-21 16:22:19 -08: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	Experiment with common-good module	2020-01-21 16:22:19 -08:00
.travis.yml	Specify exact Node.js engine support and test it	2020-01-31 10:59:10 -08:00
CHANGELOG.md	2.11.0	2020-01-16 11:58:00 -08:00
LICENSE	Add LICENSE file (for AGPL-3.0)	2020-01-28 17:45:00 -08:00
README.md	add contributing link to readme	2020-01-28 14:33:05 -05:00
package-lock.json	Merge pull request #125 from christianbundy/no-links2	2020-01-31 15:29:11 -08:00
package.json	Merge pull request #125 from christianbundy/no-links2	2020-01-31 15:29:11 -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. This can be
              changed on the 'meta' page while Oasis is running.
                                                      [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

Please make sure that your Node.js version is the current or active LTS release.

Want more? Check out install.md.

Resources

License

AGPL-3.0