3.2.5: bug fixes & translation updates (#195)

- fixed banner overlap
- update translations for new strings
- docs: update readme & create contributing.md

CONTRIBUTING.md

@@ -0,0 +1,69 @@
+# Contributing
+
+All types of contributions are welcome, if this includes to the website, API, CDN (assets) translations or maybe even something else.
+
+## Table of Contents
+
+- [Reporting Bugs](#reporting-bugs)
+- [Contributing to the Website](#contributing-to-the-website)
+- [Contributing to the API](#contributing-to-the-api)
+- [Contributing to Assets](#contributing-to-assets)
+- [Contributing to Translations](#contributing-to-translations)
+- [Commit Message Guidelines](#commit-message-guidelines)
+- [I want to contribute](#i-want-to-contribute)
+
+## Reporting Bugs
+
+If you find a bug, please open an issue [here](https://github.com/dromzeh/wanderer.moe/issues/new/choose) and fill out the template, please make sure there isn't already an issue open for the bug you are reporting, or that it already hasn't been fixed in the `development` branch.
+
+## Contributing to the Website
+
+As stated in the [README](README.md), the website is built with [SvelteKit](https://kit.svelte.dev/), the website is hosted on [Cloudflare Pages](https://pages.cloudflare.com/).
+
+Please read the README for more information on how to setup the website locally, etc.
+
+All contributions to the website are welcome, such as bug fixes, code improvements, new features, etc etc.
+
+> **Note**: All PRs should be made to the `development` branch, if you made a PR to the `main` branch, it will be closed unless it is a hotfix or something similar.
+
+## Contributing to the API
+
+The API is built with [Cloudflare Workers](https://workers.cloudflare.com/) and is available at [api.wanderer.moe](https://api.wanderer.moe/), the API's code is available [here](https://git.dromzeh.dev/api.wanderer.moe).
+
+Please read the README for more information on how to setup the API locally, etc.
+
+## Contributing to Assets
+
+Assets are hosted on [Cloudflare R2](https://www.cloudflare.com/products/r2/), the assets are available at [cdn.wanderer.moe](https://cdn.wanderer.moe/).
+
+If you have assets to share, please fill out the [Asset Request Form](https://wanderer.moe/asset-request-form) and I will review your submission, currently takes around 1-2 weeks for submissions to be added.
+
+## Contributing to Translations
+
+Translations are handled by [Crowdin](https://crowdin.com/), you will need to create an account on Crowdin and send me a message on discord (dromzeh#1337) or email: [[email protected]]([email protected]) for access.
+
+## Commit Message Guidelines
+
+Commit messages should follow the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) guidelines.
+
+Example:
+
+``` sh
+chore(deps): update all dependencies
+```
+
+or:
+
+```sh
+feat: add x to y
+```
+
+## I want to contribute
+
+> 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.
+
+As stated if you want to contribute to the website, please open a PR to the `development` branch.
+
+Please use the [API repo](https://git.dromzeh.dev/api.wanderer.moe) for API contributions or API related issues. API PRs are to be made to the `main` branch.
+
+Translation PRs will not be accepted, please use Crowdin for translations, read [Contributing to Translations](#contributing-to-translations) for more information on how to contribute to translations.

README.md

@@ -1,45 +1,84 @@
-<h1 align="center">wanderer.moe</h1>
-<p align="center">Centralized database of various game assets</p>
+# wanderer.moe
 
-<p align="center">
-  <a href="https://deepsource.io/gh/dromzeh/wanderer.moe/?ref=repository-badge}" target="_blank"><img alt="DeepSource" title="DeepSource" src="https://deepsource.io/gh/dromzeh/wanderer.moe.svg/?label=active+issues&token=EzKEOHLDivZSRTyThM-VLLsH"/></a>
-  <a href="https://deepsource.io/gh/dromzeh/wanderer.moe/?ref=repository-badge}" target="_blank"><img alt="DeepSource" title="DeepSource" src="https://deepsource.io/gh/dromzeh/wanderer.moe.svg/?label=resolved+issues&token=EzKEOHLDivZSRTyThM-VLLsH"/></a>
-  <a title="Crowdin" target="_blank" href="https://crowdin.com"><img src="https://badges.crowdin.net/wanderermoe/localized.svg"></a>
-</p>
+Source code for [wanderer.moe](https://wanderer.moe) - A centralized database of various game assets (and some other stuff)
 
-> ℹ️ Any contributions are welcome.
+This website is built by dromzeh using SvelteKit, Tailwind CSS, and Node.js, hosted with the Cloudflare Stack (Pages, Workers, R2).
 
-## Getting Started
+![wanderer.moe](https://badges.crowdin.net/wanderermoe/localized.svg)
+
+## Local Development & Build
 
 To run the website locally, follow these steps:
 
-1. Clone the repository
-2. Navigate to the project directory and run `pnpm install` to install the required dependencies
-3. Run `pnpm run dev` to start the development server. The website will be available at `http://localhost:1337` (or another port if 1337 is already in use)
-4. To build the website, run `pnpm run build`.
-5. After the build process is complete, run `pnpm run preview` to preview the built site at `http://localhost:5741`
+1. Read [API & CDN](#api--cdn) first.
 
-## Deployment
+2. Clone the repository, either `main` or `development` branch dependant on your use case: `git clone https://github.com/dromzeh/wanderer.moe (-b development)`
 
-This website is deployed on Cloudflare Pages and uses Workers (api subdomain) & R2 (cdn subdomain)
+3. Navigate to the project directory, run `pnpm install` to install the required dependencies
 
-Previous versions of the website were deployed on Netlify - `netlify.toml` config file is still present in the repository for reference.
+4. Run `pnpm run dev` to start the development server. The website will be available at `http://localhost:1337` (or another port if 1337 is already in use)
 
-**Cloudflare Configuration:**
+5. To build the website, run `pnpm run build`.
 
-```
+6. After the build process is complete, run `pnpm run preview` to preview the built site at `http://localhost:5741`
+
+## API & CDN
+
+> **Note**:
+> There are currently CORS rules setup with if you are using wanderer.moe's cdn, you may need to create your own R2 instance and change the `cdn` subdomain to your own R2 instance, make sure to also clone & modify the api & update the URLs.
+
+The API and CDN have their own respective subdomains, `api` and `cdn`.
+
+The API is powered by Cloudflare Workers and the CDN is powered by Cloudflare R2, the api's code is available [here](https://git.dromzeh.dev/api.wanderer.moe)
+
+More details on setting up the API [here](https://github.com/dromzeh/api.wanderer.moe#usage).
+
+## Production Deployment & Configuration
+
+### Redirects
+
+View `src/hooks.server.ts` for the current redirects.
+
+### Cloudflare Configuration
+
+#### Build Command
+
+```bash
 npx pnpm i --store=node_modules/.pnpm-store && npx pnpm run build
 ```
 
-This code installs the dependencies, builds the website.
+#### Build Output Directory
+
+```bash
+/.svelte-kit/cloudflare
+```
+
+## Contributing
+
+### Development
+
+All contributions are welcome, please make all PRS to the `development` branch.
+
+### Assets & Translations
+
+Asset contributions or requesting access to the Crowdin project can be sent to me on discord (dromzeh#1337) or email: [[email protected]](mailto:[email protected])
+
+A more detailed guide on contributing can be found [here](CONTRIBUTING.md)
+
+## Contributors
+
+### Developers
+
+- [@dromzeh](https://github.com/dromzeh) - Project Lead & Developer (Website, API & CDN)
+
+### Asset Contributors & Translators
 
-## Credits
+A full list can be found [here](https://wanderer.moe/contributors)
 
-This website was built by dromzeh using SvelteKit, Tailwind CSS, and Node.js, and is hosted with Cloudflare Stack.
-Redirects are done in `/src/hooks/hooks.server.js`
+### Translations
 
-A list of contributors can be found [here](https://wanderer.moe/contributors)
+Translations are managed on [Crowdin](https://crowdin.com/project/wanderermoe) and are automatically synced with the `src/locales/***.json` language files on the `development` branch, @ [l18n_development](https://github.com/dromzeh/wanderer.moe/tree/l18n_development)
 
 ## License
 
-This website is licensed under the [GPL-3 License](https://www.gnu.org/licenses/gpl-3.0.en.html)
+- [wanderer.moe](https://wanderer.moe) is licensed under [GNU Affero General Public License v3.0](LICENSE) - **You must state all significant changes made to the original software, make the source code available to the public with credit to the original author, original source, and use the same license.**

package.json

@@ -2,7 +2,7 @@
   "type": "module",
   "name": "wanderer.moe",
   "description": "Centralized database of various game assets",
-  "version": "3.2.0",
+  "version": "3.2.5",
   "scripts": {
     "dev": "vite dev --port 1337 --host",
     "build": "vite build",
@@ -24,10 +24,10 @@
     "exceljs": "^4.3.0",
     "localforage": "^1.10.0",
     "lodash.debounce": "^4.0.8",
-    "postcss": "^8.4.23",
+    "postcss": "^8.4.24",
     "postcss-nested": "^6.0.1",
     "prettier": "^2.8.8",
-    "prettier-plugin-svelte": "^2.10.0",
+    "prettier-plugin-svelte": "^2.10.1",
     "prettier-plugin-tailwindcss": "^0.3.0",
     "svelte": "^3.59.1",
     "svelte-i18n": "^3.6.0",
@@ -45,7 +45,7 @@
     "@sentry/svelte": "^7.53.1",
     "@svackages/sveltekit-hook-redirect": "^0.0.1",
     "@sveltejs/adapter-cloudflare": "^2.3.0",
-    "@sveltejs/kit": "1.19.0",
+    "@sveltejs/kit": "1.20.0",
     "axios": "^1.4.0",
     "file-saver": "^2.0.5",
     "glob": "^10.2.6",