https://github.com/fraction/flotilla
Flotilla is a quick and easy SSB service that provides common plugins without any of the usual configuration hassles.
https://github.com/fraction/flotilla
Last synced: 10 months ago
JSON representation
Flotilla is a quick and easy SSB service that provides common plugins without any of the usual configuration hassles.
- Host: GitHub
- URL: https://github.com/fraction/flotilla
- Owner: fraction
- Created: 2019-09-16T20:19:02.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2023-01-06T02:39:11.000Z (over 3 years ago)
- Last Synced: 2025-08-02T01:28:29.840Z (11 months ago)
- Language: JavaScript
- Homepage:
- Size: 840 KB
- Stars: 7
- Watchers: 1
- Forks: 2
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Flotilla
Flotilla is a quick and easy SSB service that provides common plugins without
any of the usual configuration hassles.
## Example
After installing, launch Oasis from the command line by running:
```javascript
const flotilla = require("@fraction/flotilla");
const ssb = flotilla();
ssb.whoami((err, res) => {
if (err) throw err;
console.log(res.id);
ssb.close();
});
```
You can pass an object to `flotilla()` to override SSB-Config.
## 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](https://nodejs.org/en/about/releases/), you should [download Node.js](https://nodejs.org/en/about/releases/) first.
Then, install Flotilla:
```shell
npm install @fraction/flotilla
```
## Resources
- [Help](https://github.com/fraction/flotilla/issues/new)
- [Source Code](https://github.com/fraction/flotilla.git)
## See Also
- [Oasis](https://github.com/fraction/oasis)
- [SSB-Server](https://github.com/ssbc/ssb-server)
## License
AGPL-3.0