Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/prose-im/prose-app-web
Prose Web application. XMPP client for team messaging.
https://github.com/prose-im/prose-app-web
app typescript vuejs web xmpp xmpp-client
Last synced: 2 months ago
JSON representation
Prose Web application. XMPP client for team messaging.
- Host: GitHub
- URL: https://github.com/prose-im/prose-app-web
- Owner: prose-im
- License: mpl-2.0
- Created: 2023-01-05T08:36:16.000Z (almost 2 years ago)
- Default Branch: master
- Last Pushed: 2024-09-17T13:57:55.000Z (3 months ago)
- Last Synced: 2024-09-26T12:21:51.923Z (3 months ago)
- Topics: app, typescript, vuejs, web, xmpp, xmpp-client
- Language: Vue
- Homepage: https://prose.org/downloads
- Size: 8.11 MB
- Stars: 23
- Watchers: 6
- Forks: 2
- Open Issues: 39
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# 
[](https://github.com/prose-im/prose-app-web/actions/workflows/test.yml) [](https://github.com/prose-im/prose-app-web/actions/workflows/build.yml) [](https://github.com/prose-im/prose-app-web/actions/workflows/bundle.yml) [](https://github.com/prose-im/prose-app-web/releases)
**Prose Web application. Built in TypeScript / VueJS / WebAssembly.**
The Prose project was originally announced in a blog post: [Introducing Prose, Decentralized Team Messaging in an Era of Centralized SaaS](https://prose.org/blog/introducing-prose/). This project is the Web implementation of the Prose app.
Copyright 2023, Prose Foundation - Released under the [Mozilla Public License 2.0](./LICENSE.md).
_Tested at NodeJS version: `v20.10.0`_
## 🧑💻 Prose is looking for a VueJS developer!
**We are looking for a VueJS developer to take over development of this project, and other Prose projects built with VueJS.** You will work with [@valeriansaliou](https://github.com/valeriansaliou), we are 100% remote and [async](https://remote.com/blog/why-you-should-be-doing-async-work).
👉 Interested? **[Contact us there](https://prose.org/contact/).**
## Quick Setup
### Docker image
A Docker image containing a production build of the Prose Web app is available on Docker Hub as [proseim/prose-app-web](https://hub.docker.com/r/proseim/prose-app-web/). It contains all required assets and listens as a HTTP server serving those assets with the proper rules.
**First, pull the `proseim/prose-app-web` image:**
```bash
docker pull proseim/prose-app-web:latest
```
**Then, run it:**
```bash
docker run --rm -p 8080:8080 proseim/prose-app-web
```
That's it, your Prose Web app should now be available at: [http://localhost:8080](http://localhost:8080/)
### Manual build
If you prefer to make your own build, first make sure your build environment has NodeJS version `12` and above.
Then, execute those commands:
```bash
npm install
npm run build
```
The built files will be available in the `dist/` directory. The content of this directory need to be copied to your Web server and served from a root URL.
## Architecture
The Prose Web app consists mostly of VueJS views, bound to core libraries, namely the [client](https://github.com/prose-im/prose-core-client) and [views](https://github.com/prose-im/prose-core-views) cores, that are common to all platforms Prose runs on.
The app uses the core client library to connect to XMPP. It calls programmatic methods in order to interact with its internal database and the network. It binds as well to an event bus to receive network events, or update events from the store. Messages are shown in their own view, which is provided by the core views library.
This decoupling makes things extremely clean, and enables common code sharing between platforms (eg. Web, macOS, iOS, etc.).
## Build
_👉 This builds Prose for use in a Web browser._
Building the Prose Web app is done per-target environment. Please check below for build instructions based on your target environment.
### Production target
To build Prose for a production environment (with all optimizations, meaning the build will be slower), hit:
```bash
npm run build
```
The production build expects the XMPP domain you will connect to through Prose to expose its alternative connection endpoints (ie. WebSocket or/and BOSH) through [XEP-0156: Discovering Alternative XMPP Connection Methods](https://xmpp.org/extensions/xep-0156.html), so make sure the `host-meta` file is properly added to your domain (served over HTTPS).
### Development target
_👉 Before you start, please make sure that a local `prose-pod-server` ([repository](https://github.com/prose-im/prose-pod-server)) is running on your development machine. Configurations for your local server can be sourced from `prose-pod-system` ([repository](https://github.com/prose-im/prose-pod-system))._
#### 📦 Develop with a release core (default)
To build Prose for a development environment (that is, a live development server streaming changes live), hit:
```bash
npm run dev
```
#### 🔬 Develop with a local core (advanced)
##### ⚙️ Client core
If it is desired to build against a local `prose-core-client` ([repository](https://github.com/prose-im/prose-core-client)) containing a built `prose-sdk-js` package, you may pass a `PROSE_CORE_CLIENT_PATH` environment variable with the relative path to the core client library:
```bash
PROSE_CORE_CLIENT_PATH="../prose-core-client" npm run dev
```
On a second terminal, you may also watch for changes in the `prose-core-client` repository:
```bash
find crates bindings/prose-sdk-js/src Cargo.toml | entr -r cargo xtask wasm-pack build --dev
```
Any change happening in the core will trigger a compilation run, which itself will trigger a HMR event in the Web app (this may reload the whole app).
##### 💬 Views core
If you would like to source a local `prose-core-views` ([repository](https://github.com/prose-im/prose-core-views)) build, you may pass a `PROSE_CORE_VIEWS_PATH` environment variable with the relative path to the core views library:
```bash
PROSE_CORE_VIEWS_PATH="../prose-core-views" npm run dev
```
## Bundle
_👉 This bundles Prose for use as a standalone application (macOS, Windows, etc.)._
Prose can be bundled into a native-like application using [Tauri](https://tauri.app/), which uses the target system default Web renderer. The benefit of Tauri over eg. Electron, is that the resulting bundled application size is kept small (Tauri's overhead is about 600KB).
### Production bundle
To bundle Prose as a final production application, run:
```bash
npm run bundle build
```
### Development bundle
To bundle Prose as a development application (with Hot Module Replacement), run:
```bash
npm run bundle dev
```
## Design
_👉 The Prose Web app reference design [can be found there](https://github.com/prose-im/prose-medley/blob/master/designs/app/prose-app-web.sketch)._
## Updates
As Prose is still being developed, update videos can be found on the Prose blog, month by month:
- 🎥 [Prose Development Update: November 2023](https://prose.org/blog/prose-development-update-november-2023/)
## License
Licensing information can be found in the [LICENSE.md](./LICENSE.md) document.
## :fire: Report A Vulnerability
If you find a vulnerability in any Prose system, you are more than welcome to report it directly to Prose Security by sending an encrypted email to [[email protected]](mailto:[email protected]). Do not report vulnerabilities in public GitHub issues, as they may be exploited by malicious people to target production systems running an unpatched version.
**:warning: You must encrypt your email using Prose Security GPG public key: [:key:57A5B260.pub.asc](https://files.prose.org/public/keys/gpg/57A5B260.pub.asc).**