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 🙈
1,129 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 679a2bff74 Revert "Removes husky to fix #346" 
Problem: I keep forgetting to run tests and my commits aren't actually
passing in CI. I'd really like for these to be run automatically so that
I don't have to remember my pre-commit hooks.

Solution: Revert commit d9e829e2e8, which
Nick Wynja added to remove Husky as a pre-commit hook. I hope that
anyone who doesn't want to run the pre-commit hook will run Git with the
`--no-verify` option, and anyone bummed at this change will open a
conversation to discuss in more details (or just revert *this* commit).

See-also: https://github.com/fraction/oasis/issues/346
 		2020-11-22 21:08:45 +01:00
.github Increase dependabot open PR limit 2020-11-21 16:51:26 -08:00
contrib Refactor Docker example 2020-05-10 13:52:47 -07:00
docs Refactor Docker example 2020-05-10 13:52:47 -07:00
scripts Remove debug output and add comments 2020-02-26 20:40:23 -08:00
src Merge flotilla source code into Oasis 2020-11-22 10:10:53 -08:00
test Remove unused fixtures 2020-11-20 16:42:07 -08:00
.cspell.json Fix tests and remove workaround 2020-11-11 08:25:38 -08:00
.dockerignore Refactor Docker example 2020-05-10 13:52:47 -07:00
.gitignore ignore vim swap files 2020-10-19 10:04:39 +02:00
.huskyrc Revert "Removes husky to fix #346" 2020-11-22 21:08:45 +01:00
.mailmap Add .mailmap for canonical identities 2020-03-24 16:59:20 -07:00
.prettierignore Add very basic test suite 2020-04-03 09:17:13 -07:00
.stylelintrc Experiment with common-good module 2020-01-21 16:22:19 -08:00
LICENSE Add LICENSE file (for AGPL-3.0) 2020-01-28 17:45:00 -08:00
README.md Add Matrix chat room to readme 2020-03-27 09:24:13 -07:00
package-lock.json Revert "Removes husky to fix #346" 2020-11-22 21:08:45 +01:00
package.json Revert "Removes husky to fix #346" 2020-11-22 21:08:45 +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. Switch to any SSB app you want at any time.

🌐 Bring your own browser.
Use your favorite web browser to read and write messages to the people you care about. Oasis runs a small HTTP server on your own computer, 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

After installing, launch Oasis from the command line by running:

oasis

It will then pop open a browser window for you.

Screenshot of Oasis

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

Installation

First, you'll need Node.js and npm on your computer. Run node --version to see if you have it. If not, or if it's older than the current or active LTS version, you should download Node.js first.

Then you can install the stable version of Oasis:

npm -g install fraction/oasis#semver:

Or, for faster updates and less stability, install Oasis from GitHub and upgrade often.

npm -g install fraction/oasis

Check out install.md for more information.

FAQ

Can I use the same profile from multiple computers?

No, this is a limitation of SSB. You'll need to make a separate profile on each device. There is a workaround we'd like to implement which ties your multiple profiles together.

Can I run this at the same time as Patchwork and other SSB apps?

Yes! They will both use the same data and profile. You can either run them one at a time or simultaneously. If you run them at the same time, start Patchwork first, then Oasis.

Details: SSB apps have two parts: a "server" that manages the database (on your own computer), and a user interface that gets things from the server to display. Only one server can run at a time, but multiple apps can use it.

App Runs its own SSB server Can use SSB server of another app
Oasis Yes, unless one is already running Yes
Patchwork Yes No, only uses its own server
Patchbay Yes No, only uses its own server
Patchfox No Yes, depends on other apps to provide a server

Resources

See Also

License

AGPL-3.0