diff --git a/.github/DISCUSSION_TEMPLATE/issue-triage.yml b/.github/DISCUSSION_TEMPLATE/issue-triage.yml index 7c8ded3d..82d61fec 100644 --- a/.github/DISCUSSION_TEMPLATE/issue-triage.yml +++ b/.github/DISCUSSION_TEMPLATE/issue-triage.yml @@ -4,7 +4,7 @@ body: attributes: value: | > [!IMPORTANT] - > Please read through [the Discussion rules](https://github.com/cinnyapp/cinny/discussions/2653) and check for both existing [Discussions](https://github.com/cinnyapp/cinny/discussions?discussions_q=) and [Issues](https://github.com/cinnyapp/cinny/issues?q=sort%3Areactions-desc) prior to opening a new Discussion. + > Please check for both existing Discussions and Issues prior to opening a new Discussion. - type: markdown attributes: value: "# Issue Details" @@ -26,7 +26,7 @@ body: attributes: label: Expected Behavior description: | - Describe how you expect Cinny to behave in this situation. + Describe how you expect Vojo to behave in this situation. placeholder: | I expected the message to appear in the room timeline immediately after sending. OR @@ -37,7 +37,7 @@ body: attributes: label: Actual Behavior description: | - Describe how Cinny actually behaves in this situation. If it is not immediately obvious how the actual behavior differs from the expected behavior described above, please be sure to mention the deviation specifically. + Describe how Vojo actually behaves in this situation. If it is not immediately obvious how the actual behavior differs from the expected behavior described above, please be sure to mention the deviation specifically. placeholder: | The application freezes for 3 seconds and then shows a white screen. validations: @@ -48,7 +48,7 @@ body: description: | Provide a detailed set of step-by-step instructions for reproducing this issue. placeholder: | - 1. Open Cinny and log in to my account + 1. Open Vojo and log in to my account 2. Navigate to the #general room 3. Type a message in the message box 4. Press Enter to send @@ -62,14 +62,12 @@ body: Please provide information about your environment. Include the following: - OS: - Browser: - - Cinny Web Version: (app.cinny.in or self hosted) - - Cinny desktop Version: (appimage or deb or flatpak) + - Vojo Web Version: (vojo.chat or self hosted) - Matrix Homeserver: placeholder: | - OS: Windows 11 - Browser: Chrome 120.0.6099.109 - - Cinny Web Version: 3.2.0 (app.cinny.in or self hosted) - - Cinny desktop Version: 3.2.0 (appimage or deb or flatpak) + - Vojo Web Version: (vojo.chat or self hosted) - Matrix Homeserver: matrix.org (Synapse 1.97.0) render: text validations: @@ -116,12 +114,12 @@ body: value: | # User Acknowledgements > [!TIP] - > Use these links to review the existing Cinny [Discussions](https://github.com/cinnyapp/cinny/discussions?discussions_q=) and [Issues](https://github.com/cinnyapp/cinny/issues?q=sort%3Areactions-desc). + > Use the search function to review existing Discussions and Issues. - type: checkboxes #add faqs in future attributes: label: "I acknowledge that:" options: - - label: I have searched the Cinny repository (both open and closed Discussions and Issues) and confirm this is not a duplicate of an existing issue or discussion. + - label: I have searched the Vojo repository (both open and closed Discussions and Issues) and confirm this is not a duplicate of an existing issue or discussion. required: true - label: I have checked the "Preview" tab on all text fields to ensure that everything looks right, and have wrapped all configuration and code in code blocks with a group of three backticks (` ``` `) on separate lines. required: true diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml index e24e8dcf..3cda24b2 100644 --- a/.github/FUNDING.yml +++ b/.github/FUNDING.yml @@ -1,3 +1 @@ -github: ajbura -liberapay: ajbura -open_collective: cinny +# Vojo project funding diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index a5eea79c..639c9251 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -1,5 +1,5 @@ blank_issues_enabled: false contact_links: - name: Features, Bug Reports, Questions - url: https://github.com/cinnyapp/cinny/discussions/new/choose + url: https://github.com/nicejuice-cc/vojo/discussions/new/choose about: Our preferred starting point if you have any questions or suggestions about features or behavior. diff --git a/.github/workflows/cla.yml b/.github/workflows/cla.yml deleted file mode 100644 index 42eab7ef..00000000 --- a/.github/workflows/cla.yml +++ /dev/null @@ -1,36 +0,0 @@ -name: 'CLA Assistant' -on: - issue_comment: - types: [created] - pull_request_target: - types: [opened, closed, synchronize] - -jobs: - CLAssistant: - runs-on: ubuntu-latest - steps: - - name: 'CLA Assistant' - if: (github.event.comment.body == 'recheck' || github.event.comment.body == 'I have read the CLA Document and I hereby sign the CLA') || github.event_name == 'pull_request_target' - # Beta Release - uses: cla-assistant/github-action@ca4a40a7d1004f18d9960b404b97e5f30a505a08 # v2.6.1 - env: - GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} - # the below token should have repo scope and must be manually added by you in the repository's secret - PERSONAL_ACCESS_TOKEN: ${{ secrets.CLA_PAT }} - with: - path-to-signatures: 'signatures.json' - path-to-document: 'https://github.com/cinnyapp/cla/blob/main/cla.md' # e.g. a CLA or a DCO document - # branch should not be protected - branch: 'main' - allowlist: ajbura,bot* - - #below are the optional inputs - If the optional inputs are not given, then default values will be taken - remote-organization-name: cinnyapp - remote-repository-name: cla - #create-file-commit-message: 'For example: Creating file for storing CLA Signatures' - #signed-commit-message: 'For example: $contributorName has signed the CLA in #$pullRequestNo' - #custom-notsigned-prcomment: 'pull request comment with Introductory message to ask new contributors to sign' - #custom-pr-sign-comment: 'The signature to be committed in order to sign the CLA' - #custom-allsigned-prcomment: 'pull request comment when all contributors has signed, defaults to **CLA Assistant Lite bot** All Contributors have signed the CLA.' - #lock-pullrequest-aftermerge: false - if you don't want this bot to automatically lock the pull request after merging (default - true) - #use-dco-flag: true - If you are using DCO instead of CLA diff --git a/.github/workflows/deploy-pull-request.yml b/.github/workflows/deploy-pull-request.yml index baaa181f..a4fc308a 100644 --- a/.github/workflows/deploy-pull-request.yml +++ b/.github/workflows/deploy-pull-request.yml @@ -43,7 +43,7 @@ jobs: enable-commit-comment: false env: NETLIFY_AUTH_TOKEN: ${{ secrets.NETLIFY_AUTH_TOKEN }} - NETLIFY_SITE_ID: ${{ secrets.NETLIFY_SITE_ID_PR_CINNY }} + NETLIFY_SITE_ID: ${{ secrets.NETLIFY_SITE_ID_PR_VOJO }} timeout-minutes: 1 - name: Comment preview on PR uses: thollander/actions-comment-pull-request@24bffb9b452ba05a4f3f77933840a6a841d1b32b #v3.0.1 diff --git a/.github/workflows/docker-pr.yml b/.github/workflows/docker-pr.yml index 960aeb8f..9b9263c7 100644 --- a/.github/workflows/docker-pr.yml +++ b/.github/workflows/docker-pr.yml @@ -46,7 +46,6 @@ jobs: uses: docker/metadata-action@c299e40c65443455700f0fdfc63efafe5b349051 # v5.10.0 with: images: | - ajbura/cinny ghcr.io/${{ github.repository }} - name: Build Docker image (no push) diff --git a/.github/workflows/prod-deploy.yml b/.github/workflows/prod-deploy.yml index 15485694..4fdccd09 100644 --- a/.github/workflows/prod-deploy.yml +++ b/.github/workflows/prod-deploy.yml @@ -53,7 +53,7 @@ jobs: NETLIFY_SITE_ID: ${{ secrets.NETLIFY_SITE_ID_APP }} timeout-minutes: 1 - name: Create tar.gz - run: tar -czvf cinny-${{ steps.vars.outputs.tag }}.tar.gz dist + run: tar -czvf vojo-${{ steps.vars.outputs.tag }}.tar.gz dist - name: Sign tar.gz run: | echo '${{ secrets.GNUPG_KEY }}' | gpg --batch --import @@ -63,14 +63,14 @@ jobs: # non-armored and hex-encode it so that its printable. echo "PGP Signing key, in raw PGP format in hex. Import with cat ... | xxd -r -p - | gpg --import" gpg --export | xxd -p - echo '${{ secrets.GNUPG_PASSPHRASE }}' | gpg --batch --yes --pinentry-mode loopback --passphrase-fd 0 --armor --detach-sign cinny-${{ steps.vars.outputs.tag }}.tar.gz + echo '${{ secrets.GNUPG_PASSPHRASE }}' | gpg --batch --yes --pinentry-mode loopback --passphrase-fd 0 --armor --detach-sign vojo-${{ steps.vars.outputs.tag }}.tar.gz - name: Upload tagged release uses: softprops/action-gh-release@6cbd405e2c4e67a21c47fa9e383d020e4e28b836 # v2.3.3 with: tag_name: ${{ steps.vars.outputs.tag }} files: | - cinny-${{ steps.vars.outputs.tag }}.tar.gz - cinny-${{ steps.vars.outputs.tag }}.tar.gz.asc + vojo-${{ steps.vars.outputs.tag }}.tar.gz + vojo-${{ steps.vars.outputs.tag }}.tar.gz.asc publish-image: name: Push Docker image to Docker Hub, GHCR @@ -106,7 +106,7 @@ jobs: uses: docker/metadata-action@c299e40c65443455700f0fdfc63efafe5b349051 # v5.10.0 with: images: | - ${{ secrets.DOCKER_USERNAME }}/cinny + ${{ secrets.DOCKER_USERNAME }}/vojo ghcr.io/${{ github.repository }} tags: | type=raw,value=${{ env.VERSION }} diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index f1ef5d46..b331c7c8 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -60,7 +60,7 @@ representative at an online or offline event. Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at -cinnyapp@gmail.com. +vojo@vojo.chat. All complaints will be reviewed and investigated promptly and fairly. All community leaders are obligated to respect the privacy and security of the diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 75cdacee..d03d1f9d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,26 +1,21 @@ -# Contributing to Cinny +# Contributing to Vojo -First off, thanks for taking the time to contribute! ❤️ +First off, thanks for taking the time to contribute! -All types of contributions are encouraged and valued. Please make sure to read the relevant section before making your contribution. It will make it a lot easier for us maintainers and smooth out the experience for all involved. The community looks forward to your contributions. 🎉 +All types of contributions are encouraged and valued. Please make sure to read the relevant section before making your contribution. -> And if you like the project, but just don't have time to contribute, that's fine. There are other easy ways to support the project and show your appreciation, which we would also be very happy about: +> And if you like the project, but just don't have time to contribute, that's fine. There are other easy ways to support the project and show your appreciation: > - Star the project -> - Tweet about it (tag @cinnyapp) > - Refer this project in your project's readme > - Mention the project at local meetups and tell your friends/colleagues -> - [Donate to us](https://cinny.in/#sponsor) ## Bug reports -Bug reports and feature suggestions must use descriptive and concise titles and be submitted to [GitHub Issues](https://github.com/ajbura/cinny/issues). Please use the search function to make sure that you are not submitting duplicates, and that a similar report or request has not already been resolved or rejected. +Bug reports and feature suggestions must use descriptive and concise titles and be submitted to GitHub Issues. Please use the search function to make sure that you are not submitting duplicates, and that a similar report or request has not already been resolved or rejected. ## Pull requests -> ### Legal Notice -> When contributing to this project, you must agree that you have authored 100% of the content, that you have the necessary rights to the content and that the content you contribute may be provided under the project license. You will also be asked to [sign the CLA](https://github.com/cinnyapp/cla) upon submiting your pull request. - -**NOTE: If you want to add new features, please discuss with maintainers before coding or opening a pull request.** This is to ensure that we are on same track and following our roadmap. +**NOTE: If you want to add new features, please discuss with maintainers before coding or opening a pull request.** This is to ensure that we are on the same track. **Please use clean, concise titles for your pull requests.** We use commit squashing, so the final commit in the dev branch will carry the title of the pull request. For easier sorting in changelog, start your pull request titles using one of the verbs "Add", "Change", "Remove", or "Fix" (present tense). @@ -34,11 +29,7 @@ It is not always possible to phrase every change in such a manner, but it is des **The smaller the set of changes in the pull request is, the quicker it can be reviewed and merged.** Splitting tasks into multiple smaller pull requests is often preferable. -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).** +Also, we use [ESLint](https://eslint.org/) for clean and stylistically consistent code syntax, so make sure your pull request follows it. ## 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/index.html) diff --git a/README.md b/README.md index 7cab254d..4c683ff7 100644 --- a/README.md +++ b/README.md @@ -1,93 +1,29 @@ -# Cinny -
+# Vojo 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/orgs/cinnyapp/projects/1) + +Based on [Cinny](https://github.com/cinnyapp/cinny) (MIT license). + - [Contributing](./CONTRIBUTING.md) -> [!IMPORTANT] -We are currently in the [process of replacing the matrix-js-sdk](https://github.com/cinnyapp/cinny/issues/257#issuecomment-3714406704) with our own SDK. As a result, we will not be accepting any pull requests until further notice. -Thank you for your understanding. - -
-
## Getting started
-The web app is available at [app.cinny.in](https://app.cinny.in/) and gets updated on each new release. The `dev` branch is continuously deployed at [dev.cinny.in](https://dev.cinny.in) but keep in mind that it could have things broken.
-You can also download our desktop app from the [cinny-desktop repository](https://github.com/cinnyapp/cinny-desktop).
+The web app is available at [vojo.chat](https://vojo.chat).
## Self-hosting
-To host Cinny on your own, simply download the tarball from [GitHub releases](https://github.com/cinnyapp/cinny/releases/latest), and serve the files from `dist/` using your preferred webserver. Alternatively, you can just pull the docker image from [DockerHub](https://hub.docker.com/r/ajbura/cinny) or [GitHub Container Registry](https://github.com/cinnyapp/cinny/pkgs/container/cinny).
-* The default homeservers and explore pages are defined in [`config.json`](config.json).
+To host Vojo on your own, build from source and serve the files from `dist/` using your preferred webserver.
-* You need to set up redirects to serve the assests. Example configurations; [netlify](netlify.toml), [nginx](contrib/nginx/cinny.domain.tld.conf), [caddy](contrib/caddy/caddyfile).
- * If you have trouble configuring redirects you can [enable hash routing](config.json#L35) — the url in the browser will have a `/#/` between the domain and open channel (ie. `app.cinny.in/#/home/` instead of `app.cinny.in/home/`) but you won't have to configure your webserver.
+* The default homeserver is defined in [`config.json`](config.json).
-* To deploy on subdirectory, you need to rebuild the app youself after updating the `base` path in [`build.config.ts`](build.config.ts).
- * For example, if you want to deploy on `https://cinny.in/app`, then set `base: '/app'`.
+* You need to set up redirects to serve the assets. Example configurations: [nginx](contrib/nginx/vojo.domain.tld.conf), [caddy](contrib/caddy/caddyfile).
-