Fork of Cinny https://cinny.apps.mzhang.io/

cinny cinnyapp client hacktoberfest matrix matrix-org reactjs

Find a file

Michael Zhang bd2b79c84d Run through an auto-formatter		2023-03-31 17:26:43 -05:00
.github	Run through an auto-formatter	2023-03-31 17:26:43 -05:00
.vscode	Replace Webpack to Vite (#1023 )	2022-12-20 20:47:51 +05:30
contrib/nginx	ensure new mime type comes in types.	2021-08-03 19:07:22 +02:00
public	Change license to AGPLv3 (#1115 )	2023-02-24 17:28:04 +05:30
src	Run through an auto-formatter	2023-03-31 17:26:43 -05:00
.dockerignore	Improve Dockerfile (#256 )	2022-01-30 20:58:38 +05:30
.eslintignore	Replace Webpack to Vite (#1023 )	2022-12-20 20:47:51 +05:30
.eslintrc.js	Run through an auto-formatter	2023-03-31 17:26:43 -05:00
.gitignore	Readded package-lock.json	2021-11-07 18:17:44 +05:30
.npmrc	Copy Olm directly from node modules (fixes #206 ) (#817 )	2022-09-05 12:26:44 +05:30
.prettierignore	Replace Webpack to Vite (#1023 )	2022-12-20 20:47:51 +05:30
.prettierrc.json	Run through an auto-formatter	2023-03-31 17:26:43 -05:00
_redirects	added redirects	2021-07-31 12:55:20 +05:30
config.json	Update server list in config.json (#947 )	2022-11-08 20:20:17 +05:30
CONTRIBUTING.md	Run through an auto-formatter	2023-03-31 17:26:43 -05:00
Dockerfile	Fix docker build failing (#1177 )	2023-03-29 21:57:05 +11:00
index.html	Run through an auto-formatter	2023-03-31 17:26:43 -05:00
LICENSE	Change license to AGPLv3 (#1115 )	2023-02-24 17:28:04 +05:30
package-lock.json	Release v2.2.6 (#1178 )	2023-03-29 22:02:01 +11:00
package.json	Release v2.2.6 (#1178 )	2023-03-29 22:02:01 +11:00
README.md	Add screenshot in readme (#1140 )	2023-02-26 14:22:05 +05:30
tsconfig.json	Replace Webpack to Vite (#1023 )	2022-12-20 20:47:51 +05:30
vite.config.js	Run through an auto-formatter	2023-03-31 17:26:43 -05:00
viteSvgLoader.ts	Run through an auto-formatter	2023-03-31 17:26:43 -05:00

README.md

Cinny

A Matrix client focusing primarily on simple, elegant and secure interface. The main goal is to have an instant messaging application that is easy on people and has a modern touch.

Getting started

Web app is available at https://app.cinny.in and gets updated on each new release. The dev branch is continuously deployed at https://dev.cinny.in but keep in mind that it could have things broken.

You can also download our desktop app from cinny-desktop repository.

To host Cinny on your own, download tarball of the app from GitHub release. You can serve the application with a webserver of your choice by simply copying dist/ directory to the webroot. To set default Homeserver on login and register page, place a customized config.json in webroot of your choice.

Alternatively you can just pull the DockerHub image by:

docker pull ajbura/cinny

or ghcr image by:

docker pull ghcr.io/cinnyapp/cinny:latest

PGP Public Key to verify tarball

Local development

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 Hydrogen LTS (v18).

Execute the following commands to start a development server:

npm ci # Installs all dependencies
npm start # Serve a development version

To build the app:

npm run build # Compiles the app into the dist/ directory

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.