mirror of
https://github.com/SchildiChat/schildichat-desktop.git
synced 2025-07-02 05:35:06 +02:00
Compare commits
5 Commits
Author | SHA1 | Date | |
---|---|---|---|
f0b142e996 | |||
9896d3718d | |||
3b93d5e2c6 | |||
d3c91d680b | |||
d0b44c9f96 |
24
Makefile
24
Makefile
@ -9,18 +9,19 @@ all: release
|
||||
YARN ?= yarnpkg
|
||||
|
||||
VERSION := $(shell grep version element-desktop/package.json | sed 's|.*: \"\(.*\)\",|\1|')
|
||||
APP_NAME := $(shell grep '"name"' element-desktop/package.json | head -n 1 | sed 's|.*: \"\(.*\)\",|\1|')
|
||||
WEB_APP_NAME := $(shell grep '"name"' element-web/package.json | head -n 1 | sed 's|.*: \"\(.*\)\",|\1|')
|
||||
DESKTOP_APP_NAME := $(shell grep '"name"' element-desktop/package.json | head -n 1 | sed 's|.*: \"\(.*\)\",|\1|')
|
||||
PRODUCT_NAME := $(shell grep '"productName"' element-desktop/package.json | sed 's|.*: \"\(.*\)\",|\1|')
|
||||
|
||||
WEB_OUT := element-web/dist
|
||||
WEB_OUT_DIST_VERSION := web
|
||||
OUT_WEB := $(WEB_OUT)/riot-$(WEB_OUT_DIST_VERSION).tar.gz
|
||||
OUT_WEB_BETTER_NAME := schildichat-web-$(VERSION).tar.gz
|
||||
WEB_OUT_DIST_VERSION := $(VERSION)
|
||||
OUT_WEB := $(WEB_OUT)/$(WEB_APP_NAME)-$(WEB_OUT_DIST_VERSION).tar.gz
|
||||
|
||||
DESKTOP_OUT := element-desktop/dist
|
||||
OUT_DEB64 := $(DESKTOP_OUT)/$(APP_NAME)_$(VERSION)_amd64.deb
|
||||
OUT_PAC64 := $(DESKTOP_OUT)/$(APP_NAME)-$(VERSION).pacman
|
||||
OUT_TARXZ64 := $(DESKTOP_OUT)/$(APP_NAME)-$(VERSION).tar.xz
|
||||
OUT_DEB64 := $(DESKTOP_OUT)/$(DESKTOP_APP_NAME)_$(VERSION)_amd64.deb
|
||||
OUT_PAC64 := $(DESKTOP_OUT)/$(DESKTOP_APP_NAME)-$(VERSION).pacman
|
||||
OUT_APPIMAGE64 := $(DESKTOP_OUT)/$(PRODUCT_NAME)-$(VERSION).AppImage
|
||||
OUT_TARXZ64 := $(DESKTOP_OUT)/$(DESKTOP_APP_NAME)-$(VERSION).tar.xz
|
||||
OUT_WIN64 := $(DESKTOP_OUT)/$(PRODUCT_NAME)\ Setup\ $(VERSION).exe
|
||||
OUT_WIN64_PORTABLE := $(DESKTOP_OUT)/$(PRODUCT_NAME)\ $(VERSION).exe
|
||||
OUT_WIN64_BETTER_NAME := $(PRODUCT_NAME)_Setup_v$(VERSION).exe
|
||||
@ -57,6 +58,9 @@ debian: desktop-common
|
||||
pacman: desktop-common
|
||||
$(YARN) --cwd element-desktop run build64pacman
|
||||
|
||||
appimage: desktop-common
|
||||
$(YARN) --cwd element-desktop run build64appimage
|
||||
|
||||
windows: desktop-common
|
||||
$(YARN) --cwd element-desktop run build64windows
|
||||
|
||||
@ -65,7 +69,7 @@ windows-portable: desktop-common
|
||||
|
||||
web-release: web
|
||||
mkdir -p $(CURRENT_RELEASE_DIR)
|
||||
cp $(OUT_WEB) $(CURRENT_RELEASE_DIR)/$(OUT_WEB_BETTER_NAME)
|
||||
cp $(OUT_WEB) $(CURRENT_RELEASE_DIR)
|
||||
|
||||
debian-release: debian
|
||||
mkdir -p $(CURRENT_RELEASE_DIR)
|
||||
@ -75,6 +79,10 @@ pacman-release: pacman
|
||||
mkdir -p $(CURRENT_RELEASE_DIR)
|
||||
cp $(OUT_PAC64) $(CURRENT_RELEASE_DIR)
|
||||
|
||||
appimage-release: appimage
|
||||
mkdir -p $(CURRENT_RELEASE_DIR)
|
||||
cp $(OUT_APPIMAGE64) $(CURRENT_RELEASE_DIR)
|
||||
|
||||
windows-setup-release: windows
|
||||
mkdir -p $(CURRENT_RELEASE_DIR)
|
||||
cp $(OUT_WIN64) $(CURRENT_RELEASE_DIR)/$(OUT_WIN64_BETTER_NAME)
|
||||
|
65
README.md
65
README.md
@ -1,37 +1,31 @@
|
||||
# SchildiChat-Desktop
|
||||
# SchildiChat Web/Desktop
|
||||
|
||||
SchildiChat-Desktop is a fork of [Element-Web](https://github.com/vector-im/element-web)/[-Desktop](https://github.com/vector-im/element-desktop).
|
||||
|
||||
The most important changes of SchildiChat-Desktop compared to Element are:
|
||||
SchildiChat Web/Desktop is a fork of Element [Web](https://github.com/vector-im/element-web)/[Desktop](https://github.com/vector-im/element-desktop).
|
||||
|
||||
The most important changes of SchildiChat Web/Desktop compared to Element Web/Desktop are:
|
||||
- A unifed chat list for both direct and group chats
|
||||
- Message bubbles
|
||||
- Bigger items in the room list
|
||||
- … and more!
|
||||
|
||||
While SchildiChat-Desktop should be already usable as is, it's still better seen as a
|
||||
proof-of-concept rather than a finished product, as there are still a few UX bugs
|
||||
remaining, and no ways to configure Schildi's features.
|
||||
Furthermore, I don't know how much more work I'm going to put into this, but
|
||||
if anybody wants to help improving it, contributions are welcome!
|
||||
|
||||
Downloads for Desktop: https://github.com/SchildiChat/schildichat-desktop/releases <br/>
|
||||
Hosted web variant: https://schildiweb.spiritcroc.de/
|
||||
Desktop downloads with installation instructions are listed on our website: [https://schildi.chat/desktop](https://schildi.chat/desktop)
|
||||
Hosted web variant: [https://app.schildi.chat/](https://app.schildi.chat/)
|
||||
|
||||
Feel free to [join the discussion on matrix](https://matrix.to/#/#schildichat-web:matrix.org).
|
||||
|
||||
<img src="https://raw.githubusercontent.com/SchildiChat/schildichat-desktop/sc/screenshots/1.png"/>
|
||||
|
||||
|
||||
# Building SchildiChat-Desktop
|
||||
## Building SchildiChat Web/Desktop
|
||||
|
||||
This particular repo is a wrapper project for element-desktop, element-web, matrix-react-sdk and matrix-js-sdk, in order to build SchildiChat-Desktop.
|
||||
This particular repo is a wrapper project for element-desktop, element-web, matrix-react-sdk and matrix-js-sdk in order to build SchildiChat Web **and** Desktop.
|
||||
|
||||
|
||||
## Debian compilation dependencies
|
||||
### Debian build dependencies
|
||||
|
||||
Since Debian is usually slow to update packages on its stable releases, some dependencies
|
||||
might not be recent enough to building Schildi.
|
||||
Here are the dependencies which I had to install for compilation on Debian 10:
|
||||
Since Debian is usually slow to update packages on its stable releases,
|
||||
some dependencies might not be recent enough to build SchildiChat.
|
||||
The following are the dependencies required to build SchildiChat Web/Desktop on Debian 10:
|
||||
|
||||
```
|
||||
# apt install vim curl git make gcc g++ libsqlcipher-dev pkg-config libsecret-1-dev bsdtar
|
||||
@ -49,7 +43,7 @@ $ echo 'export PATH="$PATH:$HOME/.cargo/bin"' >> .bashrc
|
||||
$ source .bashrc
|
||||
```
|
||||
|
||||
## Initial setup
|
||||
### Initial setup
|
||||
|
||||
```
|
||||
git clone --recurse-submodules https://github.com/SchildiChat/schildichat-desktop.git
|
||||
@ -57,10 +51,35 @@ cd schildichat-desktop
|
||||
make setup # optional step if using the other make targets
|
||||
```
|
||||
|
||||
## Build
|
||||
### Create release builds
|
||||
|
||||
`make [{web|debian|pacman|windows}-release]`
|
||||
Those are the builds distributed via GitHub releases.
|
||||
|
||||
## Install
|
||||
```
|
||||
# The single make targets are explained below
|
||||
make [{web|debian|windows-setup|windows-portable}-release]
|
||||
```
|
||||
|
||||
Installable packages should appear in release/.
|
||||
After that these packages which belong to to their respective make target should appear in release/\<version\>/:
|
||||
- `web`: _schildichat-web-\<version\>.tar.gz_: archive that can be unpacked and served by a **web** server (copy `config.sample.json` to `config.json` and adjust the [configuration](https://github.com/SchildiChat/element-web/blob/sc/docs/config.md) to your likings)
|
||||
- `debian`: file ready for installation on a **Debian Linux** (based) system via `dpkg -i schildichat-desktop_<version>_amd64.deb`
|
||||
- `windows-setup`: _SchildiChat_Setup_v\<version\>.exe_: file ready for **installation** on a **Windows** system
|
||||
- `windows-portable`: _SchildiChat_win-portable_v\<version\>.zip_: **portable** version for a **Windows** system – take SchildiChat together with your login data around with you (the archive contains a readme with **instructions** and **notes**)
|
||||
|
||||
#### Additional make targets not used for GitHub releases
|
||||
- `pacman`: file ready for installation on an **Arch Linux** (based) system via `pacman -U schildichat-desktop-<version>.pacman`
|
||||
- `windows-unpacked`: _SchildiChat_win-unpacked_v\<version\>.zip_: **unpacked** archive for a **Windows** system
|
||||
|
||||
### Build SchildiChat Web and deploy it directly to your web server
|
||||
|
||||
Put the `config.json` with the [configuration](https://github.com/SchildiChat/element-web/blob/sc/docs/config.md) you want for your hosted instance in a subfolder of the `configs` folder.
|
||||
Then create a file named `release.mk` and and fill it similar to that:
|
||||
```
|
||||
.PHONY: your-deploy-web
|
||||
|
||||
YOUR_CFGDIR := configs/your_subfolder
|
||||
your-deploy-%: CFGDIR := $(YOUR_CFGDIR)
|
||||
|
||||
your-deploy-web: web
|
||||
rsync --info=progress2 -rup --del element-web/webapp/ you@yourwebserver:/the/folder/served/for/schildi/
|
||||
```
|
||||
|
Submodule element-desktop updated: 937f8a8c86...9771a09566
Submodule element-web updated: 9eeb0af50a...a73a02fad1
Submodule matrix-js-sdk updated: 79a5b44eb5...02859bc8f0
Submodule matrix-react-sdk updated: 2a308ab739...925dd11e87
Reference in New Issue
Block a user