0.5.6 (zusam#79)

Co-authored-by: Neriderc <[email protected]> Co-authored-by: Daniil Kozheikin <[email protected]> Co-authored-by: Milan Šalka <[email protected]> Co-authored-by: YuxiangWang_0525(John Frederick Wang) <[email protected]> Co-authored-by: Allan Nordhøy <[email protected]> Co-authored-by: gallegonovato <[email protected]> Co-authored-by: Bruno-Van-den-Bosch <[email protected]> Co-authored-by: tabby <[email protected]> Co-authored-by: Asmodeus <[email protected]> Co-authored-by: Zina <[email protected]> Co-authored-by: தமிழ்நேரம் <[email protected]> Co-authored-by: Ettore Atalan <[email protected]> Co-authored-by: Ugur Saglam <[email protected]>
samjaninf · Oct 31, 2024 · 5930fdf · 5930fdf
1 parent e2d688a
commit 5930fdf
Show file tree

Hide file tree

Showing 153 changed files with 8,250 additions and 6,596 deletions.
diff --git a/.github/workflows/lang.yml b/.github/workflows/lang.yml
@@ -0,0 +1,15 @@
+name: Lang tests
+
+on: [pull_request]
+
+jobs:
+  validate-json:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+
+      - name: Validate JSON files
+        run: |
+          find app/src/lang -type f -name "*.json" -exec jq . {} \; || exit 1
diff --git a/.github/workflows/node.yml b/.github/workflows/node.yml
@@ -6,20 +6,25 @@ jobs:
   lint:
     runs-on: ubuntu-latest
 
+    strategy:
+      fail-fast: false
+      matrix:
+        node-version: ['18', '20', '22']
+
     steps:
     - name: Checkout code
       uses: actions/checkout@v2
 
     - name: Set up Node.js
       uses: actions/setup-node@v2
       with:
-        node-version: '18'
+        node-version: ${{ matrix.node-version }}
 
     - name: Install dependencies
       run: cd app && npm install --include=dev
 
     - name: Run ESLint
-      run: cd app && npx eslint -c .eslintrc.json src/
+      run: cd app && npm run analyze
 
     - name: Run stylelint
-      run: cd app && npx stylelint "src/scss/**/*.scss"
+      run: cd app && npm run stylelint
diff --git a/.github/workflows/php.yml b/.github/workflows/php.yml
@@ -10,7 +10,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        php-version: ['8.1', '8.2']
+        php-version: ['8.1', '8.2', '8.3']
 
     steps:
       - name: Checkout code

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,68 @@
+# Contributing to Zusam
+
+Thank you for considering contributing to Zusam! There are many ways that you can help, some of which are outlined below.
+
+<!-- TOC -->
+* [Contributing to Zusam](#contributing-to-zusam)
+  * [Report bugs and issues or request features](#report-bugs-and-issues-or-request-features)
+  * [Translate Zusam](#translate-zusam)
+  * [Contributing code](#contributing-code)
+    * [Pull requests](#pull-requests)
+    * [Setting up dev environment](#setting-up-dev-environment)
+<!-- TOC -->
+
+## Report bugs and issues or request features
+
+If you find a problem with Zusam, or if you think of a valuable feature you would like implemented, open a new issue on GitHub and describe it for us.
+
+If you find a security vulnerability, do NOT open an issue. Please instead use the [GitHub security disclosure](https://github.com/zusam/zusam/security) functionality. Also see [SECURITY.md](./SECURITY.md).
+
+## Translate Zusam
+
+You can help translate Zusam into your language by using [Weblate](https://hosted.weblate.org/projects/zusam/core/). You can log in using your GitHub account or register for a new Weblate account.
+
+## Contributing code
+
+Please note this project is [AGPLv3 licenced](https://www.gnu.org/licenses/agpl.html), and all contributions are under the same licence. Please ensure all work is your own.
+
+If you're new to contributing, see [this tutorial](https://github.com/firstcontributions/first-contributions) on contributing to projects on GitHub.
+
+Check out the [Issues](https://github.com/zusam/zusam/issues) for things that need attention.
+
+### Pull requests
+
+Please target any pull requests to the `next` branch. This branch will be merged into `master` with each release.
+
+### Setting up dev environment
+
+Start by cloning the repo. Go to the folder you want to put it inside then:
+
+`git clone https://github.com/zusam/zusam.git`
+
+Go into the zusam directory and build the dev version:
+
+`cd zusam && dev/start-dev-container`
+
+You might get an error that it can't find the container that it just built. This is often related to a podman installation. To get around this, run the make command specifically targeting docker before running the start-dev-container script:
+
+`make dev container_pgrm=docker`
+
+You'll now be inside the container, in the zusam directory. `cd app` to get to the front end app directory, then run `npm install --save-dev` to install the npm packages.
+
+Next, compile the webapp and copy to the public directory with:
+
+`npm run build; rm -r ../public/*.{js,css,map,png}; cp -r dist/* ../public/`
+
+Now install the composer dependencies by running:
+
+`cd /zusam/api && php bin/composer install`
+
+Now exit the container with ctrl + D and then run the container using repo files using:
+
+`dev/start-test-container`
+
+You should now be able to access Zusam on [http://localhost:8080](http://localhost:8080). A user `zusam` with password `zusam` is created by default.
+
+Any code updates you make in the `api` directory should be reflected immediately in this running instance. For the web app in the `app` directory, after making changes you will need to rerun the command to build and copy to the public directory: 
+
+`npm run build; rm -r ../public/*.{js,css,map,png}; cp -r dist/* ../public/`
diff --git a/README.md b/README.md
@@ -54,7 +54,7 @@ Installation guides:
 The project has the goal of being really stable for the backend once `1.0` is hit.
 That means no database structure changes, an update system and a stable API.  
 The webapp can still change a lot after that point.  
-For now, Zusam is completely usable in a day-to-day basis but is subject to significative
+For now, Zusam is completely usable in a day-to-day basis but is subject to significant
 evolutions with upcoming updates and doesn't guarantee backwards compatibility.  
 I try my best to make updates as easy as possible.
 
@@ -67,8 +67,7 @@ It should work on the latest versions of Edge and Safari but is not tested on th
 
 Zusam is free and open-source software licensed
 under [AGPLv3](https://www.gnu.org/licenses/agpl.html).  
-You can open issues for bugs you've found or features you think are missing.
-You can also submit pull requests to this repository.
+You can open issues for bugs you've found or features you think are missing, or submit pull requests to this repository. See [CONTRIBUTING.md](./CONTRIBUTING.md) for more information.
 
 Zusam is being translated using [Weblate](https://hosted.weblate.org/projects/zusam/core/):  
 <a href="https://hosted.weblate.org/engage/zusam/">

diff --git a/SECURITY.md b/SECURITY.md
@@ -0,0 +1,9 @@
+# Reporting Security Issues
+
+The Zusam team and community take security bugs in Zusam seriously. We appreciate your efforts to responsibly disclose your findings, and will make every effort to acknowledge your contributions.
+
+To report a security issue, please use the GitHub Security Advisory ["Report a Vulnerability"](https://github.com/zusam/zusam/security/advisories/new) tab.
+
+The Zusam team will send a response indicating the next steps in handling your report. After the initial reply to your report, the security team will keep you informed of the progress towards a fix and full announcement, and may ask for additional information or guidance.
+
+Please report security bugs in third-party modules to the person or team maintaining the module. 
diff --git a/api/.env b/api/.env
@@ -1,5 +1,5 @@
 # Version of the API
-VERSION="0.5.5"
+VERSION="0.5.6"
 
 # Do we allow bots ?
 ALLOW_BOTS="false"
@@ -10,6 +10,9 @@ ALLOW_IMAGE_UPLOAD="true"
 ALLOW_PDF_UPLOAD="true"
 ALLOW_AUDIO_UPLOAD="false" # not allowed since backend is not ready
 
+# Can users invite?
+SHOW_GROUP_INVITATION_LINKS="true"
+
 # Task execution intervals in seconds
 CRON_CONVERT_IMAGES="60" # 1 minute
 CRON_CONVERT_VIDEO="3600" # 1 hour
@@ -29,8 +32,10 @@ APP_ENV="prod"
 APP_SECRET="thisisaplaceholdersecret"
 ###< symfony/framework-bundle ###
 
-# DOMAIN is used to generate urls
+# Base URL information
+PROTOCOL="http"
 DOMAIN="localhost"
+PORT=""
 
 # LANG is the default language of the API
 LANG="en_US"

diff --git a/api/bin/composer b/api/bin/composer
diff --git a/api/composer.json b/api/composer.json
@@ -83,6 +83,9 @@
         "lint": [
           "php -d memory_limit=-1 ./vendor/bin/php-cs-fixer check src/ --verbose"
         ],
+        "fix": [
+          "php -d memory_limit=-1 ./vendor/bin/php-cs-fixer fix src/ --verbose"
+        ],
         "analyze": [
           "php -d memory_limit=-1 ./vendor/bin/phpstan analyse src/ -l 3"
         ],