v0.3.2

.github/workflows/release.yml

@@ -8,9 +8,6 @@ on:
   schedule:
     - cron: "0 2 * * *" # run at 2 AM UTC
 
-permissions:
-  contents: read
-
 jobs:
   web:
     name: Push website Docker image to registry

CONTRIBUTING.md

@@ -16,11 +16,15 @@ you would make is not already covered.
 - [Reporting Issues](#reporting-issues)
   - [You have a problem](#you-have-a-problem)
   - [You have a suggestion](#you-have-a-suggestion)
+- [Development](#development)
+  - [Note: `--optional` flag is **REQUIRED**](#note-optional-flag-is-required)
+  - [Tech Stack](#tech-stack)
 - [Submitting Pull Requests](#submitting-pull-requests)
   - [Getting started](#getting-started)
   - [You have a solution](#you-have-a-solution)
   - [You have an addition](#you-have-an-addition)
 - [Use the Search, Luke](#use-the-search-luke)
+- [Translation](#translation)
 - [Commit Guidelines](#commit-guidelines)
   - [Format](#format)
   - [Style](#style)
@@ -65,6 +69,31 @@ If you find one, comment on it, so we know more people are supporting it.
 If not, you can go ahead and create an issue. Please copy to anyone relevant (e.g. plugin
 maintainers) by mentioning their GitHub handle (starting with `@`) in your message.
 
+## Development
+
+To get started with development, you need `yarn` and `docker compose` installed (or know how to set up a PostgreSQL database).
+
+Steps:
+
+1. Run `git submodule update --init --recursive` to setup submodules
+1. Copy the `.env.example` to `.env` and add any api keys you need to use (e.g. for the Giant Bomb API)
+   - You can find other configuration options in the [documentation](https://docs.droposs.org/)
+1. Create the `.data` directory with `mkdir .data`
+1. Ensure that your user owns the `.data` directory with `sudo chown -R $(id -u $(whoami))`
+1. Open up a terminal and navigate to `dev-tools`, and run `docker compose up`
+1. Open up another terminal in the root directory of the project and run `yarn` and then `yarn prisma migrate dev` to setup the database
+1. Run `yarn dev` to start the development server
+
+As part of the first-time bootstrap, Drop creates an invitation with the fixed id of 'admin'. So, to create an admin account, go to:
+
+http://localhost:3000/auth/register?id=admin
+
+### Tech Stack
+
+This repo uses the Nuxt 3 + TailwindCSS stack, with the `yarn` package manager.
+
+For the database, Drop uses Prisma connected to PostgreSQL.
+
 ## Submitting Pull Requests
 
 ### Getting started
@@ -132,7 +161,7 @@ and [create an issue](#reporting-issues) or [submit a PR](#submitting-pull-reque
 
 ## Translation
 
-If you want to help translate Drop, we would love to have your help! You can do so on our weblate instance. Please make sure to read the [message format syntax](https://vue-i18n.intlify.dev/guide/essentials/syntax.html) page before starting. Failure to do so may result in your translations causing errors in Drop.
+If you want to help translate Drop, we would love to have your help! You can do so on our [weblate instance](https://translate.droposs.org/engage/drop/). Please make sure to **read** the [message format syntax](https://vue-i18n.intlify.dev/guide/essentials/syntax.html) page before starting. We use this special syntax to enable high quality translations, and failure to do so may result in your translations **causing errors** in Drop.
 
 ## Commit Guidelines
 

README.md

@@ -6,73 +6,32 @@
 # Drop
 
 [![Website](https://img.shields.io/badge/website-000000?style=for-the-badge&logo=About.me&logoColor=white)](https://droposs.org)
+[![Docs](https://img.shields.io/badge/DOCS-black?style=for-the-badge&logo=docusaurus)](https://docs.droposs.org/)
 [![Static Badge](https://img.shields.io/badge/FORUM-blue?style=for-the-badge)](https://forum.droposs.org)
 [![GitHub License](https://img.shields.io/badge/AGPL--3.0-red?style=for-the-badge)](LICENSE)
 [![Discord](https://img.shields.io/badge/Discord-5865F2?style=for-the-badge&logo=discord&logoColor=white)](https://discord.gg/ACq4qZp4a9)
 [![Open Collective](https://img.shields.io/badge/OpenCollective-1F87FF?style=for-the-badge&logo=OpenCollective&logoColor=white)](https://opencollective.com/drop-oss)
+[![Weblate project translated](https://img.shields.io/weblate/progress/drop?server=https%3A%2F%2Ftranslate.droposs.org&style=for-the-badge&logo=weblate)
+](https://translate.droposs.org/engage/drop/)
 
-Drop is an open-source game distribution platform, like GameVault or Steam. It's designed to distribute and shared DRM-free game quickly, all while being incredibly flexible, beautiful and fast.
+Drop is an open-source game distribution platform, similar to GameVault or Steam. It's designed to distribute and share DRM-free games quickly, all while being incredibly flexible, beautiful, and fast.
+
+<div align="center">
+<img src="https://droposs.org/_ipx/f_webp&q_80/images/carousel/store.png" alt="Drop Screenshot" width="900rem"/>
+</div>
 
 ## Philosophy
 
-1. Drop is flexible. While abstractions and interfaces can make the codebase more complicated, the flexibility is worth it.
-2. Drop is secure. The nature of Drop means an instance can never be accessible without authentication. In line with #1, Drop also supports a huge variety of authentication mechanisms, from a username/password to SSO.
-3. Drop is user-friendly. The interface is designed to be clean and simple to use, with complexity available to the users who want it.
+1. Drop is flexible. While abstractions and interfaces can complicate the codebase, the flexibility is worth it.
+2. Drop is secure. The nature of Drop means an instance can never be accessible without authentication. In line with #1, Drop also supports a huge variety of authentication mechanisms, from username/password to SSO.
+3. Drop is user-friendly. The interface is designed to be clean and simple to use, with advanced features available to users who want them.
 
 ## Deployment
 
-To just deploy Drop, we've set up a simple docker compose file in deploy-template.
-
-1. Generate a [GiantBomb API Key](https://www.giantbomb.com/api/)
-2. Navigate to the deploy-template directory in your terminal (`cd deploy-template`)
-3. Edit the compose.yml file (`nano compose.yml`) and copy your GiamtBomb API Key into the GIANT_BOMB_API_KEY environment variable
-4. Run `docker compose up -d`
-
-Your drop server should now be running. To register the admin user, navigate to http://your.drop.server.ip:3000/register?id=admin
-and fill in the required forms
-
-### Adding a game
-
-To add a game to the drop library, do as follows:
-
-1. Ensure that the current user owns the library folder with `sudo chown -R $(id -u $(whoami)) library`
-2. `cd library`
-3. `mkdir <GAME_NAME>` with the name of the game which you would like to register
-4. `cd <GAME_NAME>`
-5. `mkdir <VERSION_NAME>` Upload files for the specific game version to this folder
-6. Navigate to http://your.drop.server.ip:3000/
-7. Import game metadata (uses GiantBomb API Key) by selecting the game and specifying which entry to import
-8. Navigate to http://your.drop.server.ip:3000/admin/library
-9. You should see the game which you have just imported listed in this menu. There should be a notification that "Drop has detected you have new verions of this game to import". Select import here.
-10. Select the game version to import and thus fill in fields as required.
-
-## Tech Stack
-
-This repo uses the Nuxt 3 + TailwindCSS stack, with the `yarn` package manager.
-
-For the database, Drop uses Prisma connected to PostgreSQL.
-
-## Development
-
-To get started with development, you need `yarn --optional` and `docker compose` installed (or know how to set up a PostgreSQL database).
-
-### Note: `--optional` flag is **REQUIRED**
-
-Drop uses a utility package called droplet that's written in Rust. It has builts for Linux (GNU) and Windows, and they are set up as optional packages. `npm` installs these by default, but `yarn` needs the `--optional` flag.
-
-Steps:
-
-1. Run `git submodule update --init --recursive` to setup submodules
-1. Copy the `.env.example` to `.env` and add your GiantBomb metadata key (more metadata providers coming)
-1. Create the `.data` directory with `mkdir .data`
-1. Ensure that your user owns the `.data` directory with `sudo chown -R $(id -u $(whoami))`
-1. Open up a terminal and navigate to `dev-tools`, and run `docker compose up`
-1. Open up another terminal in the root directory of the project and run `yarn` and then `yarn dev` to start the dev server
-
-As part of the first-time bootstrap, Drop creates an invitation with the fixed id of 'admin'. So, to create an admin account, go to:
-
-http://localhost:3000/auth/register?id=admin
+See our documentation on how to [deploy Drop](https://docs.droposs.org/docs/guides/quickstart) for more information.
 
 ## Contributing
 
-Please see the [in-depth contributing guide](CONTRIBUTING.md)
+Please see the [in-depth contributing guide](CONTRIBUTING.md). The guide includes information on how to set up the project, how to contribute code, how to report issues, and even how to effectively translate Drop.
+
+[![Drop Translation Progress](https://translate.droposs.org/widget/drop/horizontal-auto.svg)](https://translate.droposs.org/engage/drop/)

app.vue

@@ -4,10 +4,52 @@
     <NuxtPage />
   </NuxtLayout>
   <ModalStack />
+  <div
+    v-if="showExternalUrlWarning"
+    class="fixed flex flex-row gap-x-2 right-0 bottom-0 m-2 px-2 py-2 z-50 text-right bg-red-700/90 rounded-lg"
+  >
+    <div class="flex flex-col">
+      <span class="text-sm text-zinc-200 font-bold font-display">{{
+        $t("errors.externalUrl.title")
+      }}</span>
+      <span class="text-xs text-red-400">{{
+        $t("errors.externalUrl.subtitle")
+      }}</span>
+    </div>
+    <button class="text-red-200" @click="() => hideExternalURL()">
+      <XMarkIcon class="size-5" />
+    </button>
+  </div>
 </template>
 
 <script setup lang="ts">
+import { XMarkIcon } from "@heroicons/vue/24/outline";
+
 await updateUser();
+
+const user = useUser();
+const apiDetails = await $dropFetch("/api/v1");
+
+const showExternalUrlWarning = ref(false);
+function checkExternalUrl() {
+  if (!import.meta.client) return;
+  const realOrigin = window.location.origin.trim();
+  const chosenOrigin = apiDetails.external.trim();
+  const ignore = window.localStorage.getItem("ignoreExternalUrl");
+  if (ignore && ignore == "true") return;
+  showExternalUrlWarning.value = !(realOrigin == chosenOrigin);
+}
+
+function hideExternalURL() {
+  window.localStorage.setItem("ignoreExternalUrl", "true");
+  showExternalUrlWarning.value = false;
+}
+
+if (user.value?.admin) {
+  onMounted(() => {
+    checkExternalUrl();
+  });
+}
 </script>
 
 <style scoped>

components/DropLogo.vue

@@ -1,5 +1,6 @@
 <template>
   <svg
+    aria-label="Drop Logo"
     class="text-blue-400"
     viewBox="0 0 24 24"
     fill="none"

components/DropWordmark.vue

@@ -10,7 +10,7 @@
         d="M203.371.916c-26.013-2.078-76.686 1.963-124.73 9.946L67.3 12.749C35.421 18.062 18.2 21.766 6.004 25.934 1.244 27.561.828 27.778.874 28.61c.07 1.214.828 1.121 9.595-1.176 9.072-2.377 17.15-3.92 39.246-7.496C123.565 7.986 157.869 4.492 195.942 5.046c7.461.108 19.25 1.696 19.17 2.582-.107 1.183-7.874 4.31-25.75 10.366-21.992 7.45-35.43 12.534-36.701 13.884-2.173 2.308-.202 4.407 4.442 4.734 2.654.187 3.263.157 15.593-.78 35.401-2.686 57.944-3.488 88.365-3.143 46.327.526 75.721 2.23 130.788 7.584 19.787 1.924 20.814 1.98 24.557 1.332l.066-.011c1.201-.203 1.53-1.825.399-2.335-2.911-1.31-4.893-1.604-22.048-3.261-57.509-5.556-87.871-7.36-132.059-7.842-23.239-.254-33.617-.116-50.627.674-11.629.54-42.371 2.494-46.696 2.967-2.359.259 8.133-3.625 26.504-9.81 23.239-7.825 27.934-10.149 28.304-14.005.417-4.348-3.529-6-16.878-7.066Z"
       />
     </svg>
-    <DropLogo class="h-6" />
+    <DropLogo aria-hidden="true" class="h-6" />
     <span class="text-blue-400 font-display font-bold text-xl uppercase">
       {{ $t("drop.drop") }}
     </span>

components/GameEditor/Version.vue

@@ -22,21 +22,17 @@
                   <!-- import games button -->
 
                   <NuxtLink
-                    :href="
-                      unimportedVersions.length > 0
-                        ? `/admin/library/${game.id}/import`
-                        : ''
-                    "
+                    :href="canImport ? `/admin/library/${game.id}/import` : ''"
                     type="button"
                     :class="[
-                      unimportedVersions.length > 0
+                      canImport
                         ? 'bg-blue-600 hover:bg-blue-700'
                         : 'bg-blue-800/50',
                       'inline-flex w-fit items-center gap-x-2 rounded-md  px-3 py-1 text-sm font-semibold font-display text-white shadow-sm  focus-visible:outline focus-visible:outline-2 focus-visible:outline-offset-2 focus-visible:outline-blue-600',
                     ]"
                   >
                     {{
-                      unimportedVersions.length > 0
+                      canImport
                         ? $t("library.admin.import.version.import")
                         : $t("library.admin.import.version.noVersions")
                     }}
@@ -124,10 +120,16 @@ import { ExclamationCircleIcon } from "@heroicons/vue/24/outline";
 
 // TODO implement UI for this page
 
-defineProps<{ unimportedVersions: string[] }>();
+const props = defineProps<{ unimportedVersions: string[] }>();
 
 const { t } = useI18n();
 
+const hasDeleted = ref(false);
+
+const canImport = computed(
+  () => hasDeleted.value || props.unimportedVersions.length > 0,
+);
+
 type GameAndVersions = GameModel & { versions: GameVersionModel[] };
 const game = defineModel<SerializeObject<GameAndVersions>>() as Ref<
   SerializeObject<GameAndVersions>
@@ -176,6 +178,7 @@ async function deleteVersion(versionName: string) {
       game.value.versions.findIndex((e) => e.versionName === versionName),
       1,
     );
+    hasDeleted.value = true;
   } catch (e) {
     createModal(
       ModalType.Notification,

components/LanguageSelector.vue

@@ -3,7 +3,7 @@
     <LanguageSelectorListbox />
     <NuxtLink
       class="mt-1 transition text-blue-500 hover:text-blue-600 text-sm"
-      to="https://translate.droposs.org/projects/drop/"
+      to="https://translate.droposs.org/engage/drop/"
       target="_blank"
     >
       <i18n-t
@@ -18,8 +18,12 @@
       </i18n-t>
     </NuxtLink>
 
-    <DevOnly
-      ><h1 class="mt-3 text-sm text-gray-500">{{ $t("welcome") }}</h1>
+    <DevOnly>
+      <h1 class="mt-3 text-sm text-gray-500">{{ $t("welcome") }}</h1>
     </DevOnly>
   </div>
 </template>
+
+<script setup lang="ts">
+import { ArrowTopRightOnSquareIcon } from "@heroicons/vue/24/outline";
+</script>