From 80e428a93cf217226d6fb70226d46d66039eefc9 Mon Sep 17 00:00:00 2001 From: Inventhrice <45127310+Inventhrice@users.noreply.github.com> Date: Wed, 16 Oct 2024 00:37:38 -0400 Subject: [PATCH 1/3] Adding issue templates --- .github/ISSUE_TEMPLATE/bug_report.yml | 61 ++++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.yml | 46 ++++++++++++++++ 2 files changed, 107 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yml diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 00000000..bc9de30d --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,61 @@ +name: Bug Report +description: Create a report to help us fix bugs & issues in existing supported functionality +labels: [":bug: Bug"] +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to fill out a bug report! + Please note that this form is for reporting bugs in existing supported functionality. + + If you are reporting something that's not an issue in functionality we've previously supported and/or is simply something different to your expectations, then it may be more appropriate to raise via a feature or support request instead. + - type: textarea + id: description + attributes: + label: Describe the Bug + description: Provide a clear and concise description of what the bug is. + validations: + required: true + - type: textarea + id: reproduction + attributes: + label: Steps to Reproduce + description: Detail the steps that would replicate this issue. + placeholder: | + 1. Go to '...' + 2. Click on '....' + 3. Scroll down to '....' + 4. See error + validations: + required: true + - type: textarea + id: expected + attributes: + label: Expected Behaviour + description: Provide clear and concise description of what you expected to happen. + validations: + required: true + - type: textarea + id: context + attributes: + label: Screenshots or Additional Context + description: Provide any additional context and screenshots here to help us solve this issue. + validations: + required: false + - type: input + id: devicedetails + attributes: + label: Device Details + description: | + If this is an issue that occurs when using the Hoarder interface, please provide details of the device/browser used which presents the reported issue. + placeholder: (eg. Firefox 97 (64-bit) on Windows 11) + validations: + required: false + - type: input + id: bsversion + attributes: + label: Exact Hoarder Version + description: This can be found in the bottom left of the page (eg Hoarder v0.18.0) + placeholder: (eg. v0.18.0) + validations: + required: true diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 00000000..a5a90021 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,46 @@ +name: Feature Request +description: Request a new feature or idea to be added to Hoarder +labels: [":hammer: Feature Request"] +body: + - type: textarea + id: description + attributes: + label: Describe the feature you'd like + description: Provide a clear description of the feature you'd like implemented in Hoarder + validations: + required: true + - type: textarea + id: benefits + attributes: + label: Describe the benefits this would bring to existing Hoarder users + description: | + Explain the measurable benefits this feature would achieve for existing Hoarder users. + These benefits should details outcomes in terms of what this request solves/achieves, and should not be specific to implementation. + This helps us understand the core desired goal so that a variety of potential implementations could be explored. + This field is important. Lack if input here may lead to early issue closure. + validations: + required: true + - type: textarea + id: already_achieved + attributes: + label: Can the goal of this request already be achieved via other means? + description: | + Yes/No. If yes, please describe how the requested approach fits in with the existing method. + validations: + required: true + - type: checkboxes + id: confirm-search + attributes: + label: Have you searched for an existing open/closed issue? + description: | + To help us keep these issues under control, please ensure you have first [searched our issue list](https://github.com/hoarder-app/Hoarder/issues?q=is%3Aissue) for any existing issues that cover the fundamental benefit/goal of your request. + options: + - label: I have searched for existing issues and none cover my fundamental request + required: true + - type: textarea + id: context + attributes: + label: Additional context + description: Add any other context or screenshots about the feature request here. + validations: + required: false From af416ca4db3d1089efc64a6f2367a05241a8be65 Mon Sep 17 00:00:00 2001 From: Inventhrice <45127310+Inventhrice@users.noreply.github.com> Date: Wed, 23 Oct 2024 23:43:19 -0400 Subject: [PATCH 2/3] Added persistant storage for docker --- docker/.env.sample | 3 ++- docker/docker-compose.dev.yml | 11 ++++------- 2 files changed, 6 insertions(+), 8 deletions(-) diff --git a/docker/.env.sample b/docker/.env.sample index 0b1471a0..5d720e28 100644 --- a/docker/.env.sample +++ b/docker/.env.sample @@ -3,4 +3,5 @@ DATA_DIR=/data MEILI_ADDR=http://127.0.0.1:7700 MEILI_MASTER_KEY=[generate with ] NEXTAUTH_URL=http://localhost:3000 -NEXTAUTH_SECRET=[generate with ] \ No newline at end of file +NEXTAUTH_SECRET=[generate with ] +DOCKER_DATA_DIR=[replace with the directory for persistent data] diff --git a/docker/docker-compose.dev.yml b/docker/docker-compose.dev.yml index 95883ce5..c94b4812 100644 --- a/docker/docker-compose.dev.yml +++ b/docker/docker-compose.dev.yml @@ -4,7 +4,7 @@ services: build: dockerfile: Dockerfile.dev volumes: - - data:/data + - ${DOCKER_DATA_DIR}/data:/data - ..:/app ports: - 3000:3000 @@ -30,12 +30,12 @@ services: meilisearch: image: getmeili/meilisearch:v1.6 volumes: - - meilisearch:/meili_data + - ${DOCKER_DATA_DIR}/meilisearch:/meili_data workers: build: dockerfile: Dockerfile.dev volumes: - - data:/data + - ${DOCKER_DATA_DIR}/data:/data - ..:/app working_dir: /app environment: @@ -56,13 +56,10 @@ services: environment: DATA_DIR: /data volumes: - - data:/data + - ${DOCKER_DATA_DIR}/data:/data - ..:/app command: - /bin/sh - -c - "pnpm install --frozen-lockfile && pnpm run db:migrate" -volumes: - meilisearch: - data: From 26568737cf737c2e27a4af9bfa3a1509cb6295a5 Mon Sep 17 00:00:00 2001 From: Inventhrice <45127310+Inventhrice@users.noreply.github.com> Date: Wed, 23 Oct 2024 23:44:10 -0400 Subject: [PATCH 3/3] Updating the docker dev documentation --- docs/docs/07-Development/01-setup.md | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/docs/docs/07-Development/01-setup.md b/docs/docs/07-Development/01-setup.md index 3bf9caf1..11b9d7e9 100644 --- a/docs/docs/07-Development/01-setup.md +++ b/docs/docs/07-Development/01-setup.md @@ -60,4 +60,13 @@ In dev mode, opening and closing the plugin menu should reload the code. ## Docker Dev Env -If the manual setup is too much hassle for you. You can use a docker based dev environment by running `docker compose -f docker/docker-compose.dev.yml up` in the root of the repo. This setup wasn't super reliable for me though. +If the manual setup is too much hassle for you, you can use a docker based dev environment instead by following the instructions: + +- Clone the repo and navigate to the root of the repo. +- Run `cp /docker/.env.sample /docker/.env` +- Make the necessary changes to the .env file (setting the DOCKER_DATA_DIR, NEXTAUTH_SECRET, and MEILI_MASTER_KEY) +- Run `docker compose -f docker/docker-compose.dev.yml up --build` in the root of the repo. + +### Notes +- The inital set up takes a while, do not be concerned for very long build times. +- The application is ready to work when the web-1 container says "Ready" on the next.js block