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 🙈
619 Commits 18 Branches 98 Tags 7.5 MiB
JavaScript 90.8%
CSS 7%
Go 1%
Shell 0.9%
Dockerfile 0.3%
1e28b29758
Go to file
Christian Bundy 1e28b29758 Replace cooler methods with SSB-Client promises 
Problem: We started using `cooler.get()` and `cooler.read()` because it
was impossible to use promises with SSB-Client.

Solution: I made some downstream pull requests into the MuxRPC module
and the SSB-Client module, which means that both of them now natively
support promises. This commit removes the weird convenience methods and
replaces them with the native promise support, which should hopefully
make the code easier to read and write.
2020-02-11 13:20:50 -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 screenshot with wider screenshot of art 2020-02-10 19:40:21 -08:00
scripts Add release script 2019-12-29 13:51:57 -08:00
src Replace cooler methods with SSB-Client promises 2020-02-11 13:20:50 -08:00
.cspell.json Merge branch 'master' of github.com:fraction/oasis into fix-search 2020-02-02 12:24:06 -08: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
package-lock.json Replace cooler methods with SSB-Client promises 2020-02-11 13:20:50 -08:00
package.json Replace cooler methods with SSB-Client promises 2020-02-11 13:20:50 -08:00
README.md Replace screenshot with wider screenshot of art 2020-02-10 19:40:21 -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.

Screenshot of Oasis

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 'settings' 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 stable releases with npm.

npm --global install @fraction/oasis@latest

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

For faster updates and less stability, install from GitHub and upgrade often.

npm --global install github:fraction/oasis

Want more? Check out install.md.

Resources

See Also

License

AGPL-3.0