feat: integrate FontAwesome and enhance scene permissions

- Added FontAwesome for enriched UI iconography.
- Implemented permission checks in scene edit view to prevent
unauthorized edits.
- Adjusted scene links in the category template for direct edit access,
streamlining the user workflow.

These changes aim at both enhancing the visual elements of the interface
and strengthening the security model by ensuring that only authorized
users can edit scenes. The direct edit links in the category view
further simplify navigation, making the system more intuitive for users.

CODE_OF_CONDUCT.md

@@ -0,0 +1,70 @@
+# Code of Conduct - Quackscape
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to make participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, sex characteristics, gender identity and expression,
+level of experience, education, socio-economic status, nationality, personal
+appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the
+overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+advances
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, or to ban
+temporarily or permanently any contributor for other behaviors that they deem
+inappropriate, threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at <support@private.coffee> or any of the maintainers in our [Matrix room](https://matrix.private.cf/#/#quackscape:private.coffee).
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant](https://contributor-covenant.org/), version
+[1.4](https://www.contributor-covenant.org/version/1/4/code-of-conduct/code_of_conduct.md) and
+[2.0](https://www.contributor-covenant.org/version/2/0/code_of_conduct/code_of_conduct.md),
+and was generated by [contributing-gen](https://github.com/bttger/contributing-gen).

CONTRIBUTING.md

@@ -0,0 +1,137 @@
+<!-- omit in toc -->
+# Contributing to Quackscape
+
+First off, thanks for taking the time to contribute! ❤️
+
+All types of contributions are encouraged and valued. See the [Table of Contents](#table-of-contents) for different ways to help and details about how this project handles them. 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. 🎉
+
+> 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:
+>
+> - Star the project
+> - Refer this project in your project's readme
+> - Mention the project at local meetups and tell your friends/colleagues/followers...
+
+<!-- omit in toc -->
+## Table of Contents
+
+- [Code of Conduct](#code-of-conduct)
+- [I Have a Question](#i-have-a-question)
+- [I Want To Contribute](#i-want-to-contribute)
+- [Reporting Bugs](#reporting-bugs)
+- [Suggesting Enhancements](#suggesting-enhancements)
+- [Your First Code Contribution](#your-first-code-contribution)
+- [Improving The Documentation](#improving-the-documentation)
+- [Styleguides](#styleguides)
+- [Commit Messages](#commit-messages)
+- [Join The Project Team](#join-the-project-team)
+
+## Code of Conduct
+
+This project and everyone participating in it is governed by the
+[Quackscape Code of Conduct](https://git.private.coffee/PrivateCoffee/quackscapeblob/master/CODE_OF_CONDUCT.md).
+By participating, you are expected to uphold this code. Please report unacceptable behavior
+to <support@private.coffee> or any of the maintainers in our [Matrix room](https://matrix.private.cf/#/#quackscape:private.coffee).
+
+## I Have a Question
+
+Before you ask a question, it is best to search for existing [Issues](https://git.private.coffee/PrivateCoffee/quackscape/issues) that might help you. In case you have found a suitable issue and still need clarification, you can write your question in this issue. It is also advisable to search the internet for answers first. Our [Matrix room](https://matrix.private.cf/#/#quackscape:private.coffee) is also a good place to ask for help.
+
+If you then still feel the need to ask a question and need clarification, we recommend the following:
+
+- Open an Issue in the [Private.coffee Git](https://git.private.coffee/PrivateCoffee/quackscape/issues/new) (or on [GitHub](https://github.com/PrivateCoffee/quackscape/issues/new) if you cannot use Private.coffee Git).
+- Provide as much context as you can about what you're running into.
+- Provide project and platform versions (nodejs, npm, etc), depending on what seems relevant.
+
+We will then take care of the issue as soon as possible.
+
+## I Want To Contribute
+
+> ### Legal Notice <!-- omit in toc -->
+>
+> 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 understand that your content becomes an inseparable part of the project, and grant Private.coffee unrestricted and irrevocable rights to use and redistribute your content.
+
+### Reporting Bugs
+
+<!-- omit in toc -->
+#### Before Submitting a Bug Report
+
+A good bug report shouldn't leave others needing to chase you up for more information. Therefore, we ask you to investigate carefully, collect information and describe the issue in detail in your report. Please complete the following steps in advance to help us fix any potential bug as fast as possible.
+
+- Make sure that you are using the latest version.
+- Determine if your bug is really a bug and not an error on your side e.g. using incompatible environment components/versions. If you are looking for support, you might want to check [this section](#i-have-a-question).
+- To see if other users have experienced (and potentially already solved) the same issue you are having, check if there is not already a bug report existing for your bug or error in the [bug tracker](https://git.private.coffee/PrivateCoffee/quackscapeissues?q=label%3Abug).
+- Also make sure to search the internet (including Stack Overflow) to see if users outside of the Git community have discussed the issue.
+- Collect information about the bug:
+- Stack trace (Traceback)
+- OS, Platform and Version (Windows, Linux, macOS, x86, ARM)
+- Version of the interpreter, compiler, SDK, runtime environment, package manager, depending on what seems relevant.
+- Possibly your input and the output
+- Can you reliably reproduce the issue? And can you also reproduce it with older versions?
+
+<!-- omit in toc -->
+#### How Do I Submit a Good Bug Report?
+
+> You must never report security related issues, vulnerabilities or bugs including sensitive information to the issue tracker, or elsewhere in public. Instead sensitive bugs must be sent by email to <security@private.coffee> (you can find our GPG public key at [security.private.coffee](https://security.private.coffee)) or to any of the maintainers via Matrix (simply ask in [#quackscape:private.coffee](https://matrix.private.cf/#/#quackscape:private.coffee)).
+
+We use Private.coffee Git issues to track bugs and errors. If you run into an issue with the project:
+
+- Open an Issue on [Private.coffee Git](https://git.private.coffee/PrivateCoffee/quackscape/issues/new) (or [GitHub](https://github.com/PrivateCoffee/quackscape/issues/new) if you cannot use Private.coffee Git). (Since we can't be sure at this point whether it is a bug or not, we ask you not to talk about a bug yet and not to label the issue.)
+- Explain the behavior you would expect and the actual behavior.
+- Please provide as much context as possible and describe the _reproduction steps_ that someone else can follow to recreate the issue on their own. This usually includes your code. For good bug reports you should isolate the problem and create a reduced test case.
+- Provide the information you collected in the previous section.
+
+Once it's filed:
+
+- The project team will label the issue accordingly.
+- A team member will try to reproduce the issue with your provided steps. If there are no reproduction steps or no obvious way to reproduce the issue, the team will ask you for those steps and mark the issue as `needs-repro`. Bugs with the `needs-repro` tag will not be addressed until they are reproduced.
+- If the team is able to reproduce the issue, it will be marked `needs-fix`, as well as possibly other tags (such as `critical`), and the issue will be left to be [implemented by someone](#your-first-code-contribution).
+
+### Suggesting Enhancements
+
+This section guides you through submitting an enhancement suggestion for Quackscape, **including completely new features and minor improvements to existing functionality**. Following these guidelines will help maintainers and the community to understand your suggestion and find related suggestions.
+
+<!-- omit in toc -->
+#### Before Submitting an Enhancement
+
+- Make sure that you are using the latest version.
+- Read the documentation carefully and find out if the functionality is already covered, maybe by an individual configuration.
+- Perform a [search](https://git.private.coffee/PrivateCoffee/quackscape/issues) to see if the enhancement has already been suggested. If it has, add a comment to the existing issue instead of opening a new one.
+- Find out whether your idea fits with the scope and aims of the project. It's up to you to make a strong case to convince the project's developers of the merits of this feature. Keep in mind that we want features that will be useful to the majority of our users and not just a small subset. If you're just targeting a minority of users, consider writing an add-on/plugin library.
+
+<!-- omit in toc -->
+#### How Do I Submit a Good Enhancement Suggestion?
+
+Enhancement suggestions are tracked as issues in [Private.coffee Git](https://git.private.coffee/PrivateCoffee/quackscape/issues). You can also open issues on [GitHub](https://github.com/PrivateCoffee/quackscape/issues) if you don't want to use Private.coffee Git.
+
+- Use a **clear and descriptive title** for the issue to identify the suggestion.
+- Provide a **step-by-step description of the suggested enhancement** in as many details as possible.
+- **Describe the current behavior** and **explain which behavior you expected to see instead** and why. At this point you can also tell which alternatives do not work for you.
+- You may want to **include screenshots and animated GIFs** which help you demonstrate the steps or point out the part which the suggestion is related to. You can use [this tool](https://www.cockos.com/licecap/) to record GIFs on macOS and Windows, and [this tool](https://github.com/colinkeenan/silentcast) or [this tool](https://github.com/GNOME/byzanz) on Linux.
+- **Explain why this enhancement would be useful** to most Quackscape users. You may also want to point out the other projects that solved it better and which could serve as inspiration.
+
+### Your First Code Contribution
+
+Unsure where to begin contributing to Quackscape? You can start by looking through these `good-first-issue` and `help-wanted` issues:
+
+- [Good First Issues](https://git.private.coffee/PrivateCoffee/quackscape/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22)
+- [Help Wanted Issues](https://git.private.coffee/PrivateCoffee/quackscape/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22)
+
+Both of these tags are a great starting point for new contributors. They are easy to fix and are a great way to get started with the codebase.
+
+If you decide to work on an issue, please leave a comment so that other people know that the issue is being addressed. If you are a first-time contributor, please read the [Code of Conduct](https://git.private.coffee/PrivateCoffee/quackscapeblob/master/CODE_OF_CONDUCT.md), too.
+
+If at all possible, please use our [Private.coffee Git repository](https://git.private.coffee/PrivateCoffee/quackscape/) for your contributions, as our GitHub is only a mirror of this.
+
+If you have questions or need help, please ask in our [Matrix room](https://matrix.private.cf/#/#quackscape:private.coffee).
+
+### Improving The Documentation
+
+Quackscape could always use more documentation, whether as part of the official docs, in docstrings, or even on the web in blog posts, articles, and such.
+
+## Join The Project Team
+
+If you are interested in joining the project team, please reach out to the maintainers in our [Matrix room](https://matrix.private.cf/#/#quackscape:private.coffee) and let us know how you would like to help out. We are always looking for more help and would love to have you on board!
+
+## Attribution
+
+This guide is based on the **contributing-gen**. [Make your own](https://github.com/bttger/contributing-gen)!

README.md

@@ -13,14 +13,25 @@ Quackscape is a content management system for panoramic/VR photos and videos. It
 
 ## Development Setup
 
-1. Clone the repository
+1. Clone the repository and enter it
+
+```bash
+git clone https://git.private.coffee/PrivateCoffee/quackscape.git
+cd quackscape
+```
 
 2. Create a virtual environment and install the requirements
 
 ```bash
 python3 -m venv venv
 source venv/bin/activate
-pip install -r requirements.txt
+pip install -e .
+
+# Or, to install with MySQL support:
+pip install -e .[mysql]
+
+# Or for Postgres support:
+pip install -e .[postgres]
 ```
 
 3. Install the frontend dependencies
@@ -34,27 +45,27 @@ npm install
 5. Run the migrations
 
 ```bash
-python manage.py migrate
+quackscape-manage migrate
 ```
 
 6. Compile the frontend assets
 
 ```bash
-npm run build:dev
+quackscape-manage build
 ```
 
-If you are working on the frontend, you can instead use the `npm run watch:dev` command to automatically recompile the frontend assets when they change.
+If you are working on the frontend, you can instead use the `npm run watch:dev` command to automatically recompile the frontend assets when they change. Note that if you do this, you will have to keep this running while you are working, so it will probably occupy one of your terminals.
 
 7. Run the development server
 
 ```bash
-python manage.py rundev
+quackscape-manage rundev
 ```
 
 8. Create a superuser
 
 ```bash
-python manage.py createsuperuser
+quackscape-manage createsuperuser
 ```
 
 9. Visit `http://localhost:8000` in your web browser
@@ -63,15 +74,28 @@ python manage.py createsuperuser
 
 As this is still quite a ways from a stable project, we do not include production setup steps here. Very fundamentally, the production setup would be similar to the development setup. However, there are a few differences:
 
+- You can omit the `-e` switch when running `pip install`.
 - Instead of `npm run build:dev`, you should run `npm run build`.
 - You should make sure to configure a database such as MariaDB or MySQL. You should not use the default SQLite database in production.
-- Instead of `python manage.py runserver`, you should use a production-ready web server such as Caddy and gunicorn.
+- Instead of `quackscape-manage runserver`, you should use a production-ready web server such as Caddy and gunicorn.
-- Instead of `python manage.py runserver`, you will want to use the `python manage.py runworker` command to start the background worker process.
+- Instead of `quackscape-manage runserver`, you will want to use the `quackscape-manage runworker` command to start the background worker process.
 - You may want to use systemd or another process manager to keep the server and worker processes running in the background.
 
+## S3 Storage
+
+Quackscape supports storing your static files and uploaded media in S3 buckets. During development, only MinIO was tested, but other providers, such as AWS, should work as well.
+
+This has the advantage that your local hard drive needs less capacity, but note that the workers that do your video processing will still need to have enough disk space for this task.
+
+Using S3 storage also allows you to run multiple public-facing instances, for example to balance the load, while ensuring to serve the same statics and media content on all instances.
+
+To enable S3, refer to the provided section in `settings.dist.ini`. After that, you can run `quackscape-manage collectstatic` to upload your static files to S3.
+
+One feature that may be of particular interest to those who want to work on the frontend is the `LocalStatic` option. If this is set to `1`, static files will be served by the local server instead of S3, which ensures you always work with the current state without having to run `collectstatic` all the time. In conjunction with `npm run watch:dev`, this makes it easy to work on the frontend without having to worry about the static files, while still being able to use S3 to store the media files.
+
 ## Workers
 
-Quackscape uses a background worker to process uploaded photos and videos. You can start the worker process using the `python manage.py runworker` command.
+Quackscape uses a background worker to process uploaded photos and videos. You can start the worker process using the `quackscape-manage runworker` command.
 
 You may want to run the worker process on another machine. The server part is not very resource-hungry, so it can easily run on a VPS, but for video processing, you may want to use a machine with more resources, ideally with a powerful GPU.
 
@@ -84,6 +108,10 @@ Redis = redis://<redis-ip>:6379/0
 
 Replace `<redis-ip>` with the IP address of the machine running the Redis server. This way, the worker will be able to fetch tasks from the same Redis server the Quackscape server is writing them to.
 
+## Contributing
+
+We welcome contributions to this project. Please see the [CONTRIBUTING](CONTRIBUTING.md) file for more information.
+
 ## License
 
 This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

package-lock.json

@@ -9,6 +9,7 @@
       "version": "0.0.1",
       "license": "MIT",
       "dependencies": {
+        "@fortawesome/fontawesome-free": "^6.5.1",
         "@popperjs/core": "^2.11.8",
         "aframe": "^1.5.0",
         "bootstrap": "^5.3.3",
@@ -1719,6 +1720,15 @@
         "node": ">=10.0.0"
       }
     },
+    "node_modules/@fortawesome/fontawesome-free": {
+      "version": "6.5.1",
+      "resolved": "https://registry.npmjs.org/@fortawesome/fontawesome-free/-/fontawesome-free-6.5.1.tgz",
+      "integrity": "sha512-CNy5vSwN3fsUStPRLX7fUYojyuzoEMSXPl7zSLJ8TgtRfjv24LOnOWKT2zYwaHZCJGkdyRnTmstR0P+Ah503Gw==",
+      "hasInstallScript": true,
+      "engines": {
+        "node": ">=6"
+      }
+    },
     "node_modules/@jridgewell/gen-mapping": {
       "version": "0.3.5",
       "resolved": "https://registry.npmjs.org/@jridgewell/gen-mapping/-/gen-mapping-0.3.5.tgz",

package.json

@@ -27,6 +27,7 @@
     "webpack-cli": "^5.1.4"
   },
   "dependencies": {
+    "@fortawesome/fontawesome-free": "^6.5.1",
     "@popperjs/core": "^2.11.8",
     "aframe": "^1.5.0",
     "bootstrap": "^5.3.3",

pyproject.toml

@@ -0,0 +1,48 @@
+[tool.poetry]
+name = "quackscape"
+version = "0.1.0"
+description = ""
+authors = ["Private.coffee Team <support@private.coffee>"]
+license = "MIT"
+readme = "README.md"
+homepage = "https://quackscape.io"
+repository = "https://git.private.coffee/PrivateCoffee/quackscape"
+
+[tool.poetry.dependencies]
+python = "^3.8"
+django = "*"
+djangorestframework = "*"
+django-storages = "*"
+django-polymorphic = "*"
+setuptools = "*"
+pillow = "*"
+pygments = "*"
+markdown = "*"
+coreapi = "*"
+pyyaml = "*"
+django-autosecretkey = "*"
+celery = "*"
+redis = "*"
+django-celery-results = "*"
+django-celery-beat = "*"
+drf-spectacular = {extras = ["sidecar"], version = "*"}
+boto3 = "*"
+argon2-cffi = "*"
+django-csp = "*"
+django-rest-polymorphic = "*"
+
+[tool.poetry.group.mysql.dependencies]
+mysqlclient = "*"
+
+[tool.poetry.group.postgres.dependencies]
+psycopg2 = "*"
+
+[tool.poetry.dev-dependencies]
+pytest = "^5.2"
+
+[tool.poetry.scripts]
+quackscape-manage = "quackscape.manage:main"
+
+[build-system]
+requires = ["poetry-core>=1.0.0"]
+build-backend = "poetry.core.masonry.api"

quackscape/tours/views.py

@@ -64,6 +64,14 @@ class SceneEditView(UserPermissionMixin, DetailView):
     context_object_name = "scene"
     template_name = "tours/scene_edit.html"
 
+    def get_object(self, queryset=None):
+        obj = super().get_object(queryset)
+
+        if not obj.user_has_permission(self.request.user):
+            raise PermissionDenied()
+
+        return obj
+
 
 @method_decorator(xframe_options_exempt, name="dispatch")
 class SceneEmbedView(SceneView):

quackscape/users/templates/users/category.html

@@ -54,13 +54,15 @@
         {% for scene in category.scenes.all %}
         <tr>
           <td>
-            <a href="/tours/scene/{{ scene.id }}/"
+            <a href="/tours/scene/{{ scene.id }}/edit/"
               ><img
                 src="{{ scene.thumbnail.file.url }}"
                 alt="{{ scene.title }}"
             /></a>
           </td>
-          <td><a href="/tours/scene/{{ scene.id }}/">{{ scene.title }}</a></td>
+          <td>
+            <a href="/tours/scene/{{ scene.id }}/edit/">{{ scene.title }}</a>
+          </td>
           <td>
             <!-- TODO: Actions like Edit/Delete will go here -->
           </td>

requirements.txt

@@ -1,22 +0,0 @@
-django
-djangorestframework
-django-storages
-django-polymorphic
-mysqlclient
-setuptools
-pillow
-pygments
-markdown
-coreapi
-pyyaml
-django-autosecretkey
-celery
-redis
-django-celery-results
-django-celery-beat
-drf-spectacular[sidecar]
-boto3
-psycopg2
-argon2-cffi
-django-csp
-django-rest-polymorphic