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 🙈
710 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 2e7cb4ad66 Remove readme and startup focus on configuration 
Problem: A big chunk of both the readme and the startup output is
dedicated to configuration, which feels to me to be focused on
developers and advanced users rather than beginners who just want to try
using Oasis.

Solution: Move readme configuration info to its own file and hide all
config output (except one line) behind `--debug`. While doing this I
noticed that we're `require()`ing a few modules that we don't need
before setting `process.env.DEBUG`, which I've reorganized so that we
don't accidentally disable debug mode for those modules.
 		2020-03-01 11:39:01 -08:00
.github Remove references to npm registry publish 2020-02-17 16:40:53 -08:00
contrib Experiment with common-good module 2020-01-21 16:22:19 -08:00
docs Remove readme and startup focus on configuration 2020-03-01 11:39:01 -08:00
scripts Add release script 2019-12-29 13:51:57 -08:00
src Remove readme and startup focus on configuration 2020-03-01 11:39:01 -08:00
.cspell.json Simplify installation 2020-02-29 08:31:07 -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 Add VSCode files to gitignore 2020-02-17 12:57:38 +01: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 Remove readme and startup focus on configuration 2020-03-01 11:39:01 -08:00
package-lock.json Read settings from ~/.config/oasis/config.json 2020-02-22 10:32:50 +01:00
package.json Read settings from ~/.config/oasis/config.json 2020-02-22 10:32:50 +01:00

README.md

Oasis

Oasis is a free, open-source, peer-to-peer social application that helps you follow friends and discover new ones on Secure Scuttlebutt (SSB).

🦀 Powered by SSB.
You're the center of your own distributed network. Online or offline, SSB works anywhere that you are. Follow the people you want to see and never worry about spam again. Migrate your data to another SSB app any time you want.

🌐 Bring your own browser.
Use your favorite web browser to read and write messages to the people you care about. Oasis runs over HTTP, so you don't need to worry about adding another Electron app to your computer.

🏰 Just HTML and CSS.
No browser JavaScript! Oasis has strict security rules that prevent any JavaScript from running in your browser, which helps us make Oasis accessible and easy to improve.

Example

oasis

Screenshot of Oasis

Use oasis --help to get configuration options. You can change the default values with a custom configuration.

Installation

Most people should install stable releases with npm and Node.js current or active LTS release.

npm -g install fraction/oasis#semver:

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

npm -g install fraction/oasis

Check out install.md for more information.

Resources

See Also

License

AGPL-3.0