For general documentation on Snackabra see:
If you would like to contribute or help out with the snackabra project, please feel free to reach out to us at [email protected] or [email protected]
This react web client can connect to any Snackabra server - public or private.
To run your own servers please see https://snackabra.io for documentation
First copy the template ''.env''' file to the root:
cp example.env .env
See below (Private Servers) for details.
Currently you also need to clone ''mobx-snackabra-store'' into the top directory (this will become an npm package).
Once done, you can simply:
yarn install yarn start
It should be accessible on localhost:3000.
Note: yarn start will consume the non-minimized version of snackabara-jslib to help with debugging, but it will still minified in a production build.
To create an optimized production build:
yarn build
In your project root a new folder build will contain your optimized production build.
You can serve this build using the serve package from npmjs or whatever else you'd prefer.
If you're changing messages in the UI, you will occasionally need:
yarn extract yarn compile
To maintain the internationalization setup (though currently we
only support the en locale).
For development, one suggestion is to install the React Native Chrome
Extension [1] and then open developer tools. When running the
extension against your local version (yarn start), you get the
"developer" build, and against your server you'll get "production"
build (which can also be tested locally).
By default this build will point your web app to Snackabra test servers:
REACT_APP_CHANNEL_SERVER=https://channel.384co.workers.dev REACT_APP_CHANNEL_SERVER_WS=wss://r.example.workers.dev REACT_APP_SHARD_SERVER=https://storage.384co.workers.dev
If you are running your own snackabra room server, you will need to change contents of ''.env'' file.
For example if you are running local SDK servers, you'll need:
REACT_APP_CHANNEL_SERVER=http://localhost:4000 REACT_APP_SHARD_SERVER=http://localhost:4000 REACT_APP_CHANNEL_SERVER_WS=ws://localhost:4000
You can run a personal room server and still use public storage servers, but you will only be able to read files, not upload.
Remember to always run a full ''yarn build'' after any changes to the ''.env'' file. Of course you can also point it to any other public host as well. [2]
After yarn build, you will have a set of static images (in the
'build' directory), that you can host in various ways. If you're
setting up the storage and room servers on Cloudflare, then
it might be simplest if you use Cloudflare "Pages". Detailed
documentation of how to do that is beyond the scope, but
it's pretty straightforward:
- First fork a copy for yourself of 'snackabra-webclient'
- On Cloudflare, select connecting to GitHub and authorizing it to you your forked repository.
- Select "React" as your choice of type of app / build.
- Change the default (which uses
npm) to be justyarn build
Then build and deploy. If you are running your own servers, you will also have to override the defaults in the ".env" file.
It'll take a few minutes for most of the steps, in total it should take less than 10-15 minutes.
Reminder: if you are setting up your own domain ("acme.com"), then you should end up with something like this:
acme.com -> will server the static pages of this (web) client r.acme.com -> this runs your snackabra-roomserver s.acme.com -> this runs your snackabra-storageserver
The snackabra web (app) client is a reference fully featured web client for the snackabra set of communication and data sharing services. You can use it to connect to any rooms on https://privacy.app or you can configure it to connect to any snackabra server, including personal server.
The app is written in (mostly) React Native and based on the (excellent) Gifted Chat code. [3] For a few reasons, we are currently using a slightly modified fork. [4]
Copyright (c) 2016-2023 Magnusson Institute, All Rights Reserved.
"Snackabra" is a registered trademark
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice, the above trademark notice, and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Footnotes
| [1] | https://chrome.google.com/webstore/detail/react-developer-tools/fmkadmapgofadopljbjfkapdkoienihi?hl=en |
| [2] | Future improvement will support having a list of snackabara servers that the client can query for any room, "DNS-style". |
| [3] | https://github.com/FaridSafi/react-native-gifted-chat) |
| [4] | https://github.com/Magnusson-Institute/react-native-gifted-chat |