.codespellignore

+anull
+followings
+inforce
+keypair
+nam
+nd
+readby
+serie
+upto
+afterall
+
+# Names
+nin
+noe
+manuel

.dockerignore

@@ -67,3 +67,6 @@ mailhog
 *.sqlite3
 api/music
 api/media
+
+# Docker state
+.state

.editorconfig

-# http://editorconfig.org
-
-root = true
-
-[*]
-charset = utf-8
-end_of_line = lf
-insert_final_newline = true
-trim_trailing_whitespace = true
-
-[*.{py,rst,ini}]
-indent_style = space
-indent_size = 4
-
-[*.py]
-line_length=120
-known_first_party=funkwhale_api
-multi_line_output=3
-default_section=THIRDPARTY
-
-[*.{html,js,vue,css,scss,json,yml}]
-indent_style = space
-indent_size = 2
-
-[*.md]
-trim_trailing_whitespace = false
-
-[Makefile]
-indent_style = tab

.env.example

+# api + celeryworker
+DEBUG=True
+DEFAULT_FROM_EMAIL=hello@funkwhale.test
+
+FUNKWHALE_DOMAIN=funkwhale.test
+FUNKWHALE_PROTOCOL=https
+
+DJANGO_SECRET_KEY=dev
+DJANGO_ALLOWED_HOSTS=.funkwhale.test,nginx
+DJANGO_SETTINGS_MODULE=config.settings.local
+
+DATABASE_URL=postgresql://postgres@postgres/postgres
+CACHE_URL=redis://redis:6379/0
+EMAIL_CONFIG=smtp://mailpit.funkwhale.test:1025
+
+FORCE_HTTPS_URLS=True
+EXTERNAL_REQUESTS_VERIFY_SSL=false
+
+C_FORCE_ROOT=true
+PYTHONDONTWRITEBYTECODE=true
+PYTHONTRACEMALLOC=0
+
+# api
+
+FUNKWHALE_SPA_HTML_ROOT=http://nginx/
+LDAP_ENABLED=False
+BROWSABLE_API_ENABLED=True
+
+# celeryworker
+
+CELERYD_CONCURRENCY=0
+
+# api + nginx
+
+STATIC_ROOT=/staticfiles
+MEDIA_ROOT=/data/media
+
+# api + Typesense
+TYPESENSE_API_KEY=apikey
+
+# front
+
+HOST=0.0.0.0
+VUE_PORT=8080
+
+# nginx
+
+NGINX_MAX_BODY_SIZE=10G
+
+FUNKWHALE_API_HOST=api
+FUNKWHALE_API_PORT=5000
+
+FUNKWHALE_FRONT_IP=front
+FUNKWHALE_FRONT_PORT=${VUE_PORT}
+
+# postgres
+
+POSTGRES_HOST_AUTH_METHOD=trust

.flake8

+# Use .flake8 file until pyproject.toml is supported
+# See https://github.com/PyCQA/flake8/issues/234
+[flake8]
+max-line-length = 120
+extend-exclude =
+    */migrations/*
+extend-ignore =
+    F405
+    W503
+    E203
+    E741

.gitignore

+/dist
+
 ### OSX ###
 .DS_Store
 .AppleDouble
@@ -83,16 +85,39 @@ front/yarn-debug.log*
 front/yarn-error.log*
 front/tests/unit/coverage
 front/tests/e2e/reports
+front/test_results.xml
+front/coverage/
 front/selenium-debug.log
 docs/_build
+#Tauri
+front/tauri/gen
 
-data/
+/data/
+.state
 .env
 
 po/*.po
 docs/swagger
 _build
-front/src/translations.json
-front/src/translations/*.json
-front/locales/en_US/LC_MESSAGES/app.po
 *.prof
+
+# Docker
+docker-bake.*.json
+metadata.json
+compose/var/test.*
+
+# Linting
+.eslintcache
+tsconfig.tsbuildinfo
+
+# Nix
+.direnv/
+.envrc
+flake.nix
+flake.lock
+
+# Vscode
+.vscode/
+
+# Zed
+.zed/

.gitlab/issue_templates/Default.md

+<!--
+
+Hello and welcome to our issue tracker! We appreciate you taking the time to help us make Funkwhale even better :smile:
+
+Before you begin, here are some helpful tips for submitting an issue:
+
+* If you need help setting up or using Funkwhale, try asking in our
+	[forum's support board](https://forum.funkwhale.audio/support) or our [support
+	chat room](https://riot.im/app/#/room/#funkwhale-support:tchncs.de).
+* If you think you've found a bug but aren't sure, you can ask in one of the above channels
+	first. Once you're confident it's a bug, go ahead and create an issue for us to investigate.
+	Select the **Bug** template in the **Description** dropdown menu. This template contains
+	helpful tips for creating your report.
+* For smaller additions and enhancements, please file a feature request.
+	Select the **Feature Request** template in the **Description** dropdown
+	menu. This template contains helpful tips for creating your request.
+* If you have ideas for new features or use cases, consider opening a thread in our
+	[forum](https://forum.funkwhale.audio/t/development). This enables us to
+	discuss the feature, its use cases, and the development effort it requires.
+
+We always like hearing ideas from our community. If you're still not sure, click
+the **Create issue** button and we'll work with you to sort out the issue.
+
+Happy listening! :whale:
+
+-->

.gitlab/merge_request_templates/Merge request.md

+Please avoid merging the base branch into your feature branch. We are working with rebases and those merged tend to cause trouble.
+For further questions, join us at Matrix: https://matrix.to/#/#funkwhale-dev:matrix.org
+
+If your contribution is fixing an issue by a small change, please consider a merge into `stable` by using it as target branch.
+
 Related issue: #XXX <!-- it's okay to have no issue for small changes -->
 
 This Merge Request includes:

.gitlab/renovate.json

+{
+  "$schema": "https://docs.renovatebot.com/renovate-schema.json",
+  "extends": [
+    ":dependencyDashboard",
+    ":maintainLockFilesWeekly",
+    ":enablePreCommit",
+    ":semanticCommits",
+    ":semanticCommitScopeDisabled",
+    "group:monorepos",
+    "group:recommended"
+  ],
+  "baseBranches": ["stable", "develop"],
+  "branchConcurrentLimit": 2,
+  "prConcurrentLimit": 1,
+  "rangeStrategy": "pin",
+  "ignoreDeps": ["$CI_REGISTRY/funkwhale/backend-test-docker"],
+  "packageRules": [
+    {
+      "matchFileNames": ["api/*", "front/*", "docs/*"],
+      "additionalBranchPrefix": "{{parentDir}}-",
+      "semanticCommitScope": "{{parentDir}}"
+    },
+    {
+      "matchUpdateTypes": ["lockFileMaintenance"],
+      "branchConcurrentLimit": 0,
+      "prConcurrentLimit": 0
+    },
+    {
+      "matchBaseBranches": ["develop"],
+      "matchUpdateTypes": ["major"],
+      "prPriority": 2
+    },
+    {
+      "matchBaseBranches": ["develop"],
+      "matchUpdateTypes": ["minor"],
+      "prPriority": 1
+    },
+    {
+      "matchUpdateTypes": ["major", "minor"],
+      "matchBaseBranches": ["stable"],
+      "enabled": false
+    },
+    {
+      "matchDepTypes": ["devDependencies"],
+      "matchBaseBranches": ["stable"],
+      "enabled": false
+    },
+    {
+      "matchManagers": ["npm"],
+      "addLabels": ["Area::Frontend"]
+    },
+    {
+      "matchManagers": ["poetry"],
+      "addLabels": ["Area::Backend"]
+    },
+    {
+      "groupName": "vueuse",
+      "matchDepNames": ["/^@vueuse/.*/"]
+    },
+    {
+      "matchDepNames": ["channels", "channels-redis", "daphne"],
+      "groupName": "channels"
+    },
+    {
+      "matchDepNames": ["node"],
+      "allowedVersions": "/\\d+[02468]$/"
+    },
+    {
+      "matchFileNames": ["deploy/docker-compose.yml"],
+      "matchDepNames": ["postgres"],
+      "postUpgradeTasks": {
+        "commands": [
+          "echo 'Upgrade Postgres to version {{ newVersion }}. [Make sure to migrate!](https://docs.funkwhale.audio/administrator_documentation/upgrade_docs/docker.html#upgrade-the-postgres-container)' > changes/changelog.d/postgres.update"
+        ],
+        "fileFilters": ["changes/changelog.d/postgres.update"]
+      }
+    },
+    {
+      "matchDepNames": ["python"],
+      "rangeStrategy": "widen"
+    }
+  ]
+}

.gitpod.yml

+image:
+  file: .gitpod/Dockerfile
+
+tasks:
+  - name: Backend
+    env:
+      ENV_FILE: /workspace/funkwhale/.gitpod/.env
+      COMPOSE_FILE: /workspace/funkwhale/.gitpod/docker-compose.yml
+    before: |
+      cp .gitpod/gitpod.env .gitpod/.env
+      cd api
+    init: |
+      mkdir -p ../data/media/attachments ../data/music ../data/staticfiles
+      docker-compose up -d
+
+      poetry env use python
+      make install
+
+      gp ports await 5432
+
+      poetry run funkwhale-manage migrate
+      poetry run funkwhale-manage fw users create --superuser --username gitpod --password funkwhale --email test@example.org
+      poetry run funkwhale-manage gitpod init
+    command: |
+      echo "MEDIA_URL=`gp url 8000`/media/" >> ../.gitpod/.env
+      echo "STATIC_URL=`gp url 8000`/staticfiles/" >> ../.gitpod/.env
+      echo "FUNKWHALE_HOSTNAME=`gp url 8000 | sed 's#https://##'`" >> ../.gitpod/.env
+      echo "FUNKWHALE_PROTOCOL=https" >> ../.gitpod/.env
+
+      docker-compose up -d
+      gp ports await 5432
+      poetry run funkwhale-manage collectstatic --no-input
+      poetry run funkwhale-manage gitpod dev
+
+  - name: Celery Worker
+    env:
+      ENV_FILE: /workspace/funkwhale/.gitpod/.env
+    before: cd api
+    command: |
+      gp ports await 5000
+      poetry run celery -A funkwhale_api.taskapp worker -l debug -B --concurrency=0
+
+  - name: Frontend
+    env:
+      VUE_EDITOR: code
+    before: cd front
+    init: |
+      yarn install
+    command: yarn dev --host 0.0.0.0 --base ./
+
+  - name: Documentation
+    before: cd docs
+    init: make install
+    command: make dev
+
+  - name: Welcome to Funkwhale development!
+    env:
+      COMPOSE_FILE: /workspace/funkwhale/.gitpod/docker-compose.yml
+      ENV_FILE: /workspace/funkwhale/.gitpod/.env
+      VUE_EDITOR: code
+      DJANGO_SETTINGS_MODULE: config.settings.local
+    init: |
+      pre-commit install
+      pre-commit run --all
+    command: |
+      echo ""
+      echo -e "    ⠀⠀⠸⣿⣷⣦⣄⣠⣶⣾⣿⠇⠀⠀    You can now start developing Funkwhale with gitpod!"
+      echo -e "    ⠀⠀⠀⠈⠉⠻⣿⣿⠟⠉⠁⠀⠀⠀"
+      echo -e "    \u1b[34m⣀⠀⢀⡀⢀⣀\u1b[0m⠹⠇\u1b[34m⣀⡀⢀⡀⠀⣀    \u1b[0mTo sign in to the superuser account,"
+      echo -e "    \u1b[34m⢻⣇⠘⣧⡈⠻⠶⠶⠟⢁⣾⠃⣸⡟    \u1b[0mplease use these credentials:"
+      echo -e "    \u1b[34m⠀⠻⣦⡈⠻⠶⣶⣶⠶⠟⢁⣴⠟⠀"
+      echo -e "    \u1b[34m⠀⠀⠈⠻⠷⣦⣤⣤⣴⠾⠟⠁⠀⠀    gitpod\u1b[0m:\u1b[34mfunkwhale"
+      echo ""
+
+ports:
+  - name: Funkwhale
+    port: 8000
+    visibility: public
+    onOpen: notify
+
+  - name: Funkwhale API
+    port: 5000
+    visibility: private
+    onOpen: ignore
+
+  - name: PostgreSQL
+    port: 5432
+    visibility: private
+    onOpen: ignore
+
+  - name: Debugpy
+    port: 5678
+    visibility: private
+    onOpen: ignore
+
+  - name: Redis
+    port: 6379
+    visibility: private
+    onOpen: ignore
+
+  - name: Frontend
+    port: 8080
+    visibility: private
+    onOpen: ignore
+
+  - name: Documentation
+    port: 8001
+    visibility: public
+    onOpen: notify
+
+vscode:
+  extensions:
+    - Vue.volar
+    - ms-python.python
+    - ms-toolsai.jupyter
+    - ms-toolsai.jupyter-keymap
+    - ms-toolsai.jupyter-renderers
+    - hbenl.vscode-test-explorer
+    - hbenl.test-adapter-converter
+    - littlefoxteam.vscode-python-test-adapter
+    - ZixuanChen.vitest-explorer

.gitpod/Dockerfile

+FROM gitpod/workspace-full:2023-10-25-20-43-33
+USER gitpod
+
+RUN sudo apt update -y \
+    && sudo apt install libsasl2-dev libldap2-dev libssl-dev ffmpeg gettext -y
+
+RUN pyenv install 3.11 && pyenv global 3.11
+
+RUN brew install neovim
+
+RUN pip install poetry pre-commit jinja2 towncrier \
+    && poetry config virtualenvs.create true \
+    && poetry config virtualenvs.in-project true

.gitpod/docker-compose.yml

+version: "3"
+
+services:
+  postgres:
+    image: postgres:15-alpine
+    environment:
+      - "POSTGRES_HOST_AUTH_METHOD=trust"
+    volumes:
+      - "../data/postgres:/var/lib/postgresql/data"
+    ports:
+      - 5432:5432
+
+  redis:
+    image: redis:7-alpine
+    volumes:
+      - "../data/redis:/data"
+    ports:
+      - 6379:6379
+
+  nginx:
+    env_file:
+      - ./.env
+    image: nginx
+    ports:
+      - 8000:80
+    extra_hosts:
+      - host.docker.internal:host-gateway
+    environment:
+      - "NGINX_MAX_BODY_SIZE=100M"
+      - "FUNKWHALE_API_IP=host.docker.internal"
+      - "FUNKWHALE_API_HOST=host.docker.internal"
+      - "FUNKWHALE_API_PORT=5000"
+      - "FUNKWHALE_FRONT_IP=host.docker.internal"
+      - "FUNKWHALE_FRONT_PORT=8080"
+      - "FUNKWHALE_HOSTNAME=${FUNKWHALE_HOSTNAME-host.docker.internal}"
+      - "FUNKWHALE_PROTOCOL=https"
+    volumes:
+      - ../data/media:/workspace/funkwhale/data/media:ro
+      - ../data/music:/music:ro
+      - ../data/staticfiles:/usr/share/nginx/html/staticfiles/:ro
+      - ../deploy/funkwhale_proxy.conf:/etc/nginx/funkwhale_proxy.conf:ro
+      - ../docker/nginx/conf.dev:/etc/nginx/templates/default.conf.template:ro
+      - ../front:/frontend:ro

.env.dev → .gitpod/gitpod.env

-RAVEN_ENABLED=false
-RAVEN_DSN=https://44332e9fdd3d42879c7d35bf8562c6a4:0062dc16a22b41679cd5765e5342f716@sentry.eliotberriot.com/5
-DJANGO_ALLOWED_HOSTS=.funkwhale.test,localhost,nginx,0.0.0.0,127.0.0.1
+# Dev Environment Variables
+DJANGO_ALLOWED_HOSTS=.funkwhale.test,localhost,nginx,0.0.0.0,127.0.0.1,.gitpod.io
 DJANGO_SETTINGS_MODULE=config.settings.local
-DJANGO_SECRET_KEY=dev
 C_FORCE_ROOT=true
-FUNKWHALE_HOSTNAME=localhost
-FUNKWHALE_PROTOCOL=http
-PYTHONDONTWRITEBYTECODE=true
-VUE_PORT=8080
-MUSIC_DIRECTORY_PATH=/music
 BROWSABLE_API_ENABLED=True
 FORWARDED_PROTO=http
 LDAP_ENABLED=False
-FUNKWHALE_SPA_HTML_ROOT=http://nginx/front/
+FUNKWHALE_SPA_HTML_ROOT=http://localhost:8000/
+FUNKWHALE_URL=http://localhost:8000/
+MUSIC_DIRECTORY_PATH=/workspace/funkwhale/data/music
+STATIC_ROOT=/workspace/funkwhale/data/staticfiles/
+MEDIA_ROOT=/workspace/funkwhale/data/media/
+
+PYTHONTRACEMALLOC=0
+PYTHONDONTWRITEBYTECODE=true
+
+POSTGRES_VERSION=14
+DEBUG=true
+
 
-# Uncomment this if you're using traefik/https
-# FORCE_HTTPS_URLS=True
+# Django Environment Variables
+DATABASE_URL=postgresql://postgres@localhost:5432/postgres
+DJANGO_SECRET_KEY=gitpod
+THROTTLING_ENABLED=False
 
-# Customize to your needs
-POSTGRES_VERSION=11
+# Gitpod Environment Variables

.pre-commit-config.yaml

+---
+# See https://pre-commit.com for more information
+# See https://pre-commit.com/hooks.html for more hooks
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.4.0
+    hooks:
+      - id: check-added-large-files
+      - id: check-case-conflict
+      - id: check-executables-have-shebangs
+      - id: check-shebang-scripts-are-executable
+      - id: check-symlinks
+      - id: destroyed-symlinks
+
+      - id: check-json
+      - id: check-yaml
+      - id: check-xml
+      - id: check-toml
+
+      - id: check-vcs-permalinks
+      - id: check-merge-conflict
+      - id: end-of-file-fixer
+        exclude: ^(docs/locales/.*/LC_MESSAGES)
+      - id: mixed-line-ending
+      - id: trailing-whitespace
+
+  - repo: https://github.com/python-poetry/poetry
+    rev: 1.5.1
+    hooks:
+      - id: poetry-check
+        files: ^api/pyproject.toml$
+        args: [--directory=api]
+
+      - id: poetry-lock
+        files: ^api/pyproject.toml$
+        args: [--directory=api, --check]
+
+  - repo: https://github.com/asottile/pyupgrade
+    rev: v3.9.0
+    hooks:
+      - id: pyupgrade
+        args: [--py38-plus]
+        exclude: ^(api/.*/migrations/.*)
+
+  - repo: https://github.com/psf/black
+    rev: 23.7.0
+    hooks:
+      - id: black
+
+  - repo: https://github.com/pycqa/isort
+    rev: 5.12.0
+    hooks:
+      - id: isort
+
+  - repo: https://github.com/pycqa/flake8
+    rev: 6.1.0
+    hooks:
+      - id: flake8
+
+  - repo: https://github.com/pre-commit/mirrors-prettier
+    rev: v3.0.3
+    hooks:
+      - id: prettier
+        files: \.(md|yml|yaml|json)$
+
+  - repo: https://github.com/codespell-project/codespell
+    rev: v2.2.6
+    hooks:
+      - id: codespell
+        additional_dependencies: [tomli]
+
+  - repo: https://github.com/shellcheck-py/shellcheck-py
+    rev: v0.9.0.5
+    hooks:
+      - id: shellcheck
+
+  - repo: local
+    hooks:
+      - id: pwa-manifest.json
+        name: pwa-manifest.json
+        description: Sync pwa-manifest.json
+        entry: scripts/sync-pwa-manifest.sh
+        pass_filenames: false
+        language: script
+        files: pwa-manifest.json$

.yarnrc

+--cwd front
+--add.exact true

CODEOWNERS

+*.md @funkwhale/documentation

CONTRIBUTING.md

+# Contribute to Funkwhale
+
+We welcome contributions from across the community. Whether you are a designer, a translator, a technical writer, or a developer, we look forward to working with you to improve the Funkwhale project!
+
+## Contribute to Funkwhale development
+
+The Funkwhale software is the core of the community project. While we have a core team working on it, we are always excited to see new features, bugfixes, and refactorings from our community.
+
+Funkwhale's backend is written in [Python](https://www.python.org/) using [Django](https://www.djangoproject.com) and [Django REST framework](https://www.django-rest-framework.org/). Our web app is written in [Vue.js](https://vuejs.org/) and [Typescript](https://typescriptlang.org).
+
+Whether you're an experienced developer or you're just learning, check out our [developer guide](https://docs.funkwhale.audio/developer/index.html) to get started.
+
+## Document Funkwhale
+
+Funkwhale is a large project with a lot of moving parts. To help users and developers alike, we need to keep our documentation up-to-date and readable. If you have a knack for explaining technical concepts or you've noticed a gap, check out our [documentation guide](https://docs.funkwhale.audio/documentation/index.html) to see how to get involved.
+
+## Translate Funkwhale
+
+All Funkwhale content is written in American English, but our community speaks languages from all over the world. If you'd like to see Funkwhale in your language, check out the [translation guide](https://docs.funkwhale.audio/translators.html) to see how you can help out.
+
+## Other contributions
+
+We'll update this file and our documentation with more information and workflows as we expand our search for contributors. If you have some suggestions or want to see how else you can get involved, come join us on [our forum](https://forum.funkwhale.audio). We'd love to hear your ideas!