From fd79ea4b9bb750453ff1ef5607d7b2eb8f0522ee Mon Sep 17 00:00:00 2001 From: Krishan <33421343+kfiven@users.noreply.github.com> Date: Mon, 22 Aug 2022 08:29:47 +0530 Subject: [PATCH] Simplify readme and add various helpful links (#776) * Simplyfy readme and add various helpful links * update intro * Add desktop app link --- CONTRIBUTING.md | 7 ++++- LICENSE | 2 +- README.md | 62 +++++++++++++++++++++----------------------- public/res/README.md | 2 +- 4 files changed, 37 insertions(+), 36 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 1edc09d..ba03fbc 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -36,4 +36,9 @@ It is not always possible to phrase every change in such a manner, but it is des Also, we use [ESLint](https://eslint.org/) for clean and stylistically consistent code syntax, so make sure your pull request follow it. -**For any query or design discussion, join our [Matrix room](https://matrix.to/#/#cinny:matrix.org).** \ No newline at end of file +**For any query or design discussion, join our [Matrix room](https://matrix.to/#/#cinny:matrix.org).** + +## Helpful links +- [BEM methodology](http://getbem.com/introduction/) +- [Atomic design](https://bradfrost.com/blog/post/atomic-web-design/) +- [Matrix JavaScript SDK documentation](https://matrix-org.github.io/matrix-js-sdk/19.2.0/index.html) \ No newline at end of file diff --git a/LICENSE b/LICENSE index ff85e6a..1f7a284 100644 --- a/LICENSE +++ b/LICENSE @@ -1,6 +1,6 @@ MIT License -Copyright (c) 2021 Ajay Bura (ajbura) +Copyright (c) 2021-present Ajay Bura (ajbura) Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/README.md b/README.md index 101de85..d6675bd 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,5 @@ -

- - Cinny -

-

+# Cinny +

GitHub release downloads @@ -16,21 +12,30 @@ Sponsor 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. - -- [Contributing](./CONTRIBUTING.md) +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. - [Roadmap](https://github.com/ajbura/cinny/projects/11) +- [Contributing](./CONTRIBUTING.md) -## Building and Running +## 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. -### Running pre-compiled +You can also download our desktop app from [cinny-desktop repository](https://github.com/cinnyapp/cinny-desktop). -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. +To host Cinny on your own, download tarball of the app from [GitHub release](https://github.com/cinnyapp/cinny/releases/latest). +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`](config.json) in webroot of your choice. + +Alternatively you can just pull the [DockerHub image](https://hub.docker.com/r/ajbura/cinny) by: +``` +docker pull ajbura/cinny +``` +or [ghcr image](https://github.com/cinnyapp/cinny/pkgs/container/cinny) by: +``` +docker pull ghcr.io/cinnyapp/cinny:latest +```
-PGP Public Key to verify pre-compiled tarball +PGP Public Key to verify tarball ``` -----BEGIN PGP PUBLIC KEY BLOCK----- @@ -77,48 +82,39 @@ UeGsouhyuITLwEhScounZDqop+Dx ```
-### Building from source +## 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](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. -Execute the following commands to compile the app from its source code: - +Execute the following commands to start a development server: ```sh npm ci # Installs all dependencies +npm start # Serve a development version +``` + +To build the app: +```sh 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`. +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](https://hub.docker.com/r/ajbura/cinny) by `docker pull ajbura/cinny`. - -### Configuring default Homeserver - -To set default Homeserver on login and register page, place a customized [`config.json`](config.json) in webroot of your choice. ## License -Copyright (c) 2021 Ajay Bura (ajbura) +Copyright (c) 2021-present Ajay Bura (ajbura) Code licensed under the MIT License: diff --git a/public/res/README.md b/public/res/README.md index b2ec678..4e4f7c7 100644 --- a/public/res/README.md +++ b/public/res/README.md @@ -1,4 +1,4 @@ -Graphics (c) by Ajay Bura (ajbura) +Copyright (c) 2021-present Ajay Bura (ajbura) Graphic content is licensed under a Creative Commons Attribution 4.0 International License.