Go to file

Ajay Bura a2692e1469 Fix room mention (#1459 ) * create room mention with alias if possible * display room mention text as they were sent		2023-10-19 17:43:54 +11:00
.github	Bump docker/setup-buildx-action from 2.6.0 to 2.7.0 (#1293 )	2023-06-20 09:10:12 +10: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	Refactor state & Custom editor (#1190 )	2023-06-12 16:45:23 +05:30
src	Fix room mention (#1459 )	2023-10-19 17:43:54 +11: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	Refactor timeline (#1346 )	2023-10-06 08:14:06 +05:30
.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	Replace Webpack to Vite (#1023 )	2022-12-20 20:47:51 +05:30
_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	Update sdk doc link so that it's not fixed to one version	2022-09-18 20:18:23 +05:30
Dockerfile	Bump nginx from 1.25.0-alpine to 1.25.1-alpine (#1288 )	2023-06-20 09:07:04 +10:00
index.html	Prevent `manifest.json` from being inlined (#1359 )	2023-08-03 09:53:28 +05:30
LICENSE	Change license to AGPLv3 (#1115 )	2023-02-24 17:28:04 +05:30
package-lock.json	use aria-react for message hover & focus hooks (#1456 )	2023-10-19 17:42:35 +11:00
package.json	use aria-react for message hover & focus hooks (#1456 )	2023-10-19 17:42:35 +11:00
README.md	Update project link (#1302 )	2023-06-21 17:56:27 +05:30
tsconfig.json	Refactor timeline (#1346 )	2023-10-06 08:14:06 +05:30
vite.config.js	Refactor timeline (#1346 )	2023-10-06 08:14:06 +05:30
viteSvgLoader.ts	Vite plugin to add svg as inline data (#1072 )	2023-01-15 09:52:58 +05:30

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.