https://github.com/coracle-social/flotilla
A nostr relay-based communities PWA modeled after discord
https://github.com/coracle-social/flotilla
community discord nostr slack teams
Last synced: 8 months ago
JSON representation
A nostr relay-based communities PWA modeled after discord
- Host: GitHub
- URL: https://github.com/coracle-social/flotilla
- Owner: coracle-social
- License: mit
- Created: 2024-08-05T21:46:59.000Z (almost 2 years ago)
- Default Branch: master
- Last Pushed: 2024-11-14T23:44:17.000Z (over 1 year ago)
- Last Synced: 2024-11-15T00:29:41.462Z (over 1 year ago)
- Topics: community, discord, nostr, slack, teams
- Language: Svelte
- Homepage: https://flotilla.social
- Size: 3.71 MB
- Stars: 11
- Watchers: 3
- Forks: 5
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Flotilla
A discord-like nostr client based on the idea of "relays as groups".
If you would like to be interoperable with Flotilla, please check out this guide: https://habla.news/u/hodlbod@coracle.social/1741286140797
## Environment
You can also optionally create an `.env` file and populate it with the following environment variables (see `.env` for examples):
- `VITE_DEFAULT_PUBKEYS` - A comma-separated list of hex pubkeys for bootstrapping web of trust
- `VITE_PLATFORM_URL` - The url where the app will be hosted
- `VITE_PLATFORM_NAME` - The name of the app
- `VITE_PLATFORM_LOGO` - A logo url for the app
- `VITE_PLATFORM_RELAYS` - A list of comma-separated relay urls that will make flotilla operate in "platform mode". Disables all space browse/add/select functionality and makes the first platform relay the home page.
- `VITE_PLATFORM_ACCENT` - A hex color for the app's accent color
- `VITE_PLATFORM_DESCRIPTION` - A description of the app
- `VITE_GLITCHTIP_API_KEY` - A Sentry DSN for use with glitchtip (error reporting)
- `GLITCHTIP_AUTH_TOKEN` - A glitchtip auth token for error reporting
If you're deploying a custom version of flotilla, be sure to remove the `plausible.coracle.social` script from `app.html`. This sends analytics to a server hosted by the developer.
## Development
See [./CONTRIBUTING.md](CONTRIBUTING.md).
## Deployment
To run your own Flotilla, it's as simple as:
```sh
pnpm install
pnpm run build
npx serve build
```
Or, if you prefer to use a container:
```sh
podman run -d -p 3000:3000 ghcr.io/coracle-social/flotilla:latest
```
Alternatively, you can copy the build files into a directory of your choice and serve it yourself:
```sh
mkdir ./mount
podman run -v ./mount:/app/mount ghcr.io/coracle-social/flotilla:latest bash -c 'cp -r build/* mount'
```