cinny

mirror of https://github.com/cinnyapp/cinny.git synced 2024-11-20 06:49:52 +01:00

Yet another matrix client

cinny cinnyapp client hacktoberfest matrix matrix-client matrix-org reactjs

Find a file

Krishan b0d25961ad v2.0.4		2022-05-29 10:40:34 +05:30
.github	Add support for building docker image for linux/arm64 (#494 )	2022-05-29 10:15:31 +05:30
contrib/nginx	ensure new mime type comes in types.	2021-08-03 19:07:22 +02:00
public	Load sound file on startup (#444 )	2022-05-03 13:18:27 +05:30
src	v2.0.4	2022-05-29 10:40:34 +05:30
.dockerignore	Improve Dockerfile (#256 )	2022-01-30 20:58:38 +05:30
.eslintignore	initial commit	2021-07-28 18:45:52 +05:30
.eslintrc.js	Add react/no-unstable-nested-components rule in eslintrc	2022-02-05 17:49:51 +05:30
.gitignore	Readded package-lock.json	2021-11-07 18:17:44 +05:30
_redirects	added redirects	2021-07-31 12:55:20 +05:30
config.json	Add allowCustomHomeservers config option (#525 )	2022-05-12 17:13:14 +05:30
CONTRIBUTING.md	Update contributing.md	2022-01-17 12:50:58 +05:30
Dockerfile	Bump node from 17.8.0-alpine3.15 to 17.9.0-alpine3.15 (#492 )	2022-04-19 09:35:09 +05:30
LICENSE	v2.0.0	2022-05-08 13:23:31 +05:30
olm.wasm	Updated olm -> v3.2.8, matrix-js-sdk -> v15.2.1	2021-12-13 21:07:15 +05:30
package-lock.json	v2.0.4	2022-05-29 10:40:34 +05:30
package.json	v2.0.4	2022-05-29 10:40:34 +05:30
README.md	Add alt text to sheilds	2022-05-27 14:09:53 +05:30
webpack.common.js	Add support to manage cross-signing and key backup (#461 )	2022-04-24 15:42:24 +05:30
webpack.dev.js	initial commit	2021-07-28 18:45:52 +05:30
webpack.prod.js	Bumped dependencies and v1.5.0	2021-11-07 15:46:36 +05:30

README.md

Cinny

Cinny is a Matrix client focusing primarily on simple, elegant and secure interface. The main goal is to have a client that is easy on end user and feels a modern chat application.

Building and Running

Running pre-compiled

A tarball of pre-compiled version of the app is provided with each release. You can serve the application with a webserver of your choosing by simply copying dist/ directory to the webroot.

PGP Public Key to verify pre-compiled tarball

Building from source

We recommend using a version manager as versions change very quickly. You will likely need to switch between multiple Node.js versions based on the needs of different projects you're working on. NVM on windows on Windows and nvm on Linux/macOS are pretty good choices. Also recommended nodejs version is 16.15.0 LTS.

Execute the following commands to compile the app from its source code:

npm ci # Installs all dependencies
npm run build # Compiles the app into the dist/ directory

You can then copy the files to a webserver's webroot of your choice.

To serve a development version of the app locally for testing, you need to use the command npm start.

Running with Docker

This repository includes a Dockerfile, which builds the application from source and serves it with Nginx on port 80. To use this locally, you can build the container like so:

docker build -t cinny:latest .

You can then run the container you've built with a command similar to this:

docker run -p 8080:80 cinny:latest

This will forward your localhost port 8080 to the container's port 80. You can visit the app in your browser by navigating to http://localhost:8080.

Alternatively you can just pull the DockerHub image by docker pull ajbura/cinny.

Configuring default Homeserver

To set default Homeserver on login and register page, place a customized config.json in webroot of your choice.

License

Code licensed under the MIT License: http://opensource.org/licenses/MIT

Graphics licensed under CC-BY 4.0: https://creativecommons.org/licenses/by/4.0/