2021-07-28 15:15:52 +02:00
# Cinny
2022-05-08 10:22:05 +02:00
[](https://github.com/ajbura/cinny/tree/dev)
[](https://matrix.to/#/#cinny:matrix.org)
[](https://twitter.com/@cinnyapp)
[](https://opencollective.com/cinny)
2021-07-28 15:15:52 +02:00
## Table of Contents
- [About ](#about )
- [Getting Started ](https://cinny.in )
- [Contributing ](./CONTRIBUTING.md )
2022-02-10 13:30:41 +01:00
- [Roadmap ](https://github.com/ajbura/cinny/projects/11 )
2021-07-28 15:15:52 +02:00
## About <a name = "about"></a>
2021-08-01 16:58:34 +02:00
Cinny is a [Matrix ](https://matrix.org ) client focusing primarily on simple, elegant and secure interface.
2021-08-01 17:51:58 +02:00
2022-05-01 10:08:31 +02:00
2021-09-06 19:05:36 +02:00
2021-08-01 17:51:58 +02:00
## Building and Running
2021-09-15 13:47:31 +02:00
### Running pre-compiled
A tarball of pre-compiled version of the app is provided with each [release ](https://github.com/ajbura/cinny/releases ).
You can serve the application with a webserver of your choosing by simply copying `dist/` directory to the webroot.
2021-08-01 17:51:58 +02:00
### Building from source
2022-05-21 14:03:01 +02:00
> 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 ](https://github.com/coreybutler/nvm-windows#installation--upgrades ) on Windows and [nvm ](https://github.com/nvm-sh/nvm ) on Linux/macOS are pretty good choices. Also recommended nodejs version is 16.15.0 LTS.
2021-08-01 17:51:58 +02:00
Execute the following commands to compile the app from its source code:
2021-08-02 13:51:08 +02:00
```sh
2022-01-13 06:18:08 +01:00
npm ci # Installs all dependencies
2021-08-02 13:51:08 +02:00
npm run build # Compiles the app into the dist/ directory
2021-08-01 17:51:58 +02:00
```
2022-01-13 06:18:08 +01:00
You can then copy the files to a webserver's webroot of your choice.
2021-08-01 17:54:19 +02:00
To serve a development version of the app locally for testing, you may also use the command `npm start` .
2021-08-01 17:51:58 +02:00
### 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` .
2021-09-15 13:47:31 +02:00
Alternatively you can just pull the [DockerHub image ](https://hub.docker.com/r/ajbura/cinny ) by `docker pull ajbura/cinny` .
2021-11-06 11:56:18 +01:00
### Configuring default Homeserver
To set default Homeserver on login and register page, place a customized [`config.json` ](config.json ) in webroot of your choice.
2021-09-01 12:17:50 +02:00
## License
2021-08-01 17:51:58 +02:00
2022-05-08 09:53:31 +02:00
Copyright (c) 2021 Ajay Bura (ajbura)
2021-09-01 12:17:50 +02:00
Code licensed under the MIT License: < http: / / opensource . org / licenses / MIT >
2021-09-15 13:47:31 +02:00
Graphics licensed under CC-BY 4.0: < https: / / creativecommons . org / licenses / by / 4 . 0 / >
