From 49af1fea4463264ff72abf94d7c17e5780f29b1e Mon Sep 17 00:00:00 2001 From: Ben Lawrence <65065992+Bentheminernz@users.noreply.github.com> Date: Tue, 24 Sep 2024 10:54:01 +1200 Subject: [PATCH 01/19] Fixes permissions and text spacing Makes favourite colour and page background fields not show unless user has the entitlements Tweaks padding above text and button sizing --- templates/base.html | 4 +- users/templates/users/includes/user-link.html | 90 ++++++------- users/templates/users/settings.html | 120 ++++++++++-------- 3 files changed, 114 insertions(+), 100 deletions(-) diff --git a/templates/base.html b/templates/base.html index f8456c26..0978f3b0 100644 --- a/templates/base.html +++ b/templates/base.html @@ -107,9 +107,9 @@ loading="lazy" decoding="async"> GitHub + class="bg-purple-600 hover:bg-purple-700 rounded px-4 py-3 my-auto">GitHub Discord + class="bg-purple-600 hover:bg-purple-700 rounded px-4 py-3 my-auto">Discord diff --git a/users/templates/users/includes/user-link.html b/users/templates/users/includes/user-link.html index 5c65d2d4..5337e951 100644 --- a/users/templates/users/includes/user-link.html +++ b/users/templates/users/includes/user-link.html @@ -1,48 +1,52 @@ {% load static %} - - {% if user.profile_cover and user.profile_picture %} -
- {{ user.display_name }}'s profile cover - {{ user.display_name }}'s profile picture -
-
- {{ user.display_name }} - {% if user.display_sponsor_badge %} - Splashcat Sponsor - {% endif %} +{% if user.username %} + + {% if user.profile_cover and user.profile_picture %} +
+ {{ user.display_name }}'s profile cover + {{ user.display_name }}'s profile picture +
+
+ {{ user.display_name }} + {% if user.display_sponsor_badge %} + Splashcat Sponsor + {% endif %} +
+
@{{ user.username }}
-
@{{ user.username }}
-
- {% else %} -
- {% if user.profile_picture %} - {{ user.display_name }} - {% endif %} -
-
- {{ user.display_name }} - {% if user.display_sponsor_badge %} - Splashcat Sponsor - {% endif %} + {% else %} +
+ {% if user.profile_picture %} + {{ user.display_name }} + {% endif %} +
+
+ {{ user.display_name }} + {% if user.display_sponsor_badge %} + Splashcat Sponsor + {% endif %} +
+
@{{ user.username }}
-
@{{ user.username }}
-
- {% endif %} - {% if show_splashtag == True %} - {% with user.get_splashtag as splashtag %} - {% if splashtag %} - {% include "includes/splashtag.html" with splashtag=splashtag %} - {% endif %} - {% endwith %} - {% endif %} - \ No newline at end of file + {% endif %} + {% if show_splashtag == True %} + {% with user.get_splashtag as splashtag %} + {% if splashtag %} + {% include "includes/splashtag.html" with splashtag=splashtag %} + {% endif %} + {% endwith %} + {% endif %} + +{% else %} +

No username available

+{% endif %} \ No newline at end of file diff --git a/users/templates/users/settings.html b/users/templates/users/settings.html index df2d7c7e..4af995ce 100644 --- a/users/templates/users/settings.html +++ b/users/templates/users/settings.html @@ -9,10 +9,6 @@

Settings

-
- {% csrf_token %} - -
{% if user.stripe_customer_id %}
{% csrf_token %} @@ -31,51 +27,51 @@

{{ form.display_name.errors }} - + {{ form.display_name }}
{{ form.profile_picture.errors }} - + {{ form.profile_picture }}
{{ form.profile_cover.errors }} - + {{ form.profile_cover }}
- {{ form.page_background.errors }} - -

- Shown in the background of your profile and on battles. Note that backgrounds will be darkened - when shown. -

- {{ form.page_background }} - {% if not "page-backgrounds" in user.entitlements %} -
-
- + {% if "page-backgrounds" in user.entitlements %} + {{ form.page_background.errors }} + +

+ Shown in the background of your profile and on battles. Note that backgrounds will be darkened + when shown. +

+ {{ form.page_background }} + {% else %} +
+ Become a sponsor to customize your page background.
{% endif %} -
+
- {{ form.saved_favorite_color.errors }} - -

- Sub and special weapon icons will use this color on your profile and elsewhere on Splashcat. -

- {{ form.saved_favorite_color }} - {% if not "favorite-color" in user.entitlements %} -
-
- + {% if "favorite-color" in user.entitlements %} + {{ form.saved_favorite_color.errors }} + +

+ Sub and special weapon icons will use this color on your profile and elsewhere on Splashcat. +

+ {{ form.saved_favorite_color }} + {% else %} +
+ Become a sponsor to change your favorite color.
@@ -117,7 +113,7 @@

{{ form.preferred_pronouns.errors }} -

Used for AI Battle Descriptions and shown on your profile.

+

Used for AI Generated Battle Descriptions and shown on your profile.

{{ form.preferred_pronouns }}
@@ -174,7 +170,7 @@

GitHub Sponsors

-

API Keys

+

API Keys

Create API keys to upload data to Splashcat.

@@ -183,32 +179,46 @@

API Keys

- - - - - - - - - - - - {% for api_key in user.api_keys.all %} + + {% if user.api_keys.all %} +
KeyNoteCreatedDelete
+ - - - - + + + + - {% endfor %} - -
{{ api_key.key }}{{ api_key.note }}{{ api_key.created }} -
- {% csrf_token %} - -
- 		KeyNoteCreatedDelete
+ + + {% for api_key in user.api_keys.all %} + + {{ api_key.key }} + {{ api_key.note }} + {{ api_key.created }} + +
+ {% csrf_token %} + +
+ + + {% endfor %} + + + {% endif %} +
+ +
+

Request Data Export

+

+ Request a copy of your data from Splashcat. +

+ +
+ {% csrf_token %} + +

From 6d5cd79c426adc2775757e5fff5385138c8a5a84 Mon Sep 17 00:00:00 2001 From: Ben Lawrence <65065992+Bentheminernz@users.noreply.github.com> Date: Tue, 24 Sep 2024 11:55:05 +1200 Subject: [PATCH 02/19] Tweaks to text sizing --- templates/splashcat/sponsor.html | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/templates/splashcat/sponsor.html b/templates/splashcat/sponsor.html index c9294a63..299c545e 100644 --- a/templates/splashcat/sponsor.html +++ b/templates/splashcat/sponsor.html @@ -7,7 +7,7 @@ {% endblock %} {% block content %} -

+

Heya!

@@ -33,13 +33,13 @@

Sponsor Features

{% csrf_token %} -
{% csrf_token %} -
@@ -78,13 +78,13 @@

S+ponsor Features

{% csrf_token %} -
{% csrf_token %} -
@@ -107,13 +107,13 @@

Xponsor Features

{% csrf_token %} -
{% csrf_token %} -
From 26078cc17b6fa4740b7f69fdc864d1b1c6165ed0 Mon Sep 17 00:00:00 2001 From: Ben Lawrence <65065992+Bentheminernz@users.noreply.github.com> Date: Tue, 24 Sep 2024 17:57:37 +1200 Subject: [PATCH 03/19] Fixes sizing and spacing --- templates/base.html | 4 +- templates/splashcat/sponsor.html | 217 ++++++++++++++-------------- users/templates/users/settings.html | 2 +- 3 files changed, 115 insertions(+), 108 deletions(-) diff --git a/templates/base.html b/templates/base.html index 0978f3b0..77d1cd9e 100644 --- a/templates/base.html +++ b/templates/base.html @@ -107,9 +107,9 @@ loading="lazy" decoding="async"> GitHub + class="bg-purple-600 hover:bg-purple-700 rounded px-4 py-2 my-auto">GitHub Discord + class="bg-purple-600 hover:bg-purple-700 rounded px-4 py-2 my-auto">Discord
diff --git a/templates/splashcat/sponsor.html b/templates/splashcat/sponsor.html index 299c545e..c32dd6ca 100644 --- a/templates/splashcat/sponsor.html +++ b/templates/splashcat/sponsor.html @@ -25,119 +25,126 @@

<-- that's the cool badge!

-
+
Payments are processed through Stripe.
-

Sponsor Features

-
-
- {% csrf_token %} - -
-
- {% csrf_token %} - -
+
+

Sponsor Features

+
    +
  • + Sponsor Badge + Splashcat Sponsor +

    + Must configure GitHub sponsorship privacy as public to display. +

    +
    • +
  • + Favorite Color +

    + Set a favorite color to be used for sub and special weapon icons on your profile and elsewhere on + Splashcat. +

    +

    + Sponsorship privacy does not affect this feature. +

    +
    • +
  • + Page Backgrounds +

    + Configure a background image to be shown on your profile and battle pages! +

    +

    + Sponsorship privacy does not affect this feature. +

    +
    • +
+
+
+ {% csrf_token %} + +
+
+ {% csrf_token %} + +
+
-
    -
  • - Sponsor Badge - Splashcat Sponsor -

    - Must configure GitHub sponsorship privacy as public to display. -

    -
    • -
  • - Favorite Color -

    - Set a favorite color to be used for sub and special weapon icons on your profile and elsewhere on - Splashcat. -

    -

    - Sponsorship privacy does not affect this feature. -

    -
    • -
  • - Page Backgrounds -

    - Configure a background image to be shown on your profile and battle pages! -

    -

    - Sponsorship privacy does not affect this feature. -

    -
    • -
-

S+ponsor Features

-
-
- {% csrf_token %} - -
-
- {% csrf_token %} - -
+
+

S+ponsor Features

+
    +
  • + AI Battle Descriptions +

    + Battles uploaded to Splashcat will have a short AI generated description added to them. Perfect for + sharing your battles on social media! +

    +

    + Sponsorship privacy does not affect this feature. +

    +
    • +
  • + All Sponsor Features
    • +
+
+
+ {% csrf_token %} + +
+
+ {% csrf_token %} + +
+
-
    -
  • - AI Battle Descriptions -

    - Battles uploaded to Splashcat will have a short AI generated description added to them. Perfect for - sharing your battles on social media! -

    -

    - Sponsorship privacy does not affect this feature. -

    -
    • -
  • + All Sponsor Features
    • -
-

Xponsor Features

-
-
- {% csrf_token %} - -
-
- {% csrf_token %} - -
-
-
    -
  • - Splashcat Assistant -

    - Receive insights on your battle data and create new battle groups with Splashcat Assistant. - Example Thread -

    -

    - Sponsorship privacy does not affect this feature. -

    -
    • -
  • + All Sponsor and S+ponsor Features
    • -
+
+

Xponsor Features

+
    +
  • + Splashcat Assistant +

    + Receive insights on your battle data and create new battle groups with Splashcat Assistant. + Example Thread +

    +

    + Sponsorship privacy does not affect this feature. +

    +
    • +
  • + All Sponsor and S+ponsor Features
    • +
- - Stripe Climate Badge - Splashcat contributes 1% to remove CO2 from the atmosphere. - + + Stripe Climate Badge + Splashcat contributes 1% to remove CO2 from the atmosphere. + + +
+
+ {% csrf_token %} + +
+
+ {% csrf_token %} + +
+
+
{% if current_sponsors|length > 0 %}

Current Sponsors

diff --git a/users/templates/users/settings.html b/users/templates/users/settings.html index 4af995ce..653bbd2a 100644 --- a/users/templates/users/settings.html +++ b/users/templates/users/settings.html @@ -217,7 +217,7 @@

Request Data Export

{% csrf_token %} - +
From f4224af218602f829104fd89a87008f748222363 Mon Sep 17 00:00:00 2001 From: Ben Lawrence <65065992+Bentheminernz@users.noreply.github.com> Date: Tue, 24 Sep 2024 18:10:28 +1200 Subject: [PATCH 04/19] Makes navbar stick to bottom of page Fixes more spacing and sizing Makes footer judd a link --- groups/templates/groups/admin/create.html | 2 +- groups/templates/groups/index.html | 2 +- templates/base.html | 82 ++++++++++++----------- 3 files changed, 44 insertions(+), 42 deletions(-) diff --git a/groups/templates/groups/admin/create.html b/groups/templates/groups/admin/create.html index 72ee43e0..4bb6130c 100644 --- a/groups/templates/groups/admin/create.html +++ b/groups/templates/groups/admin/create.html @@ -33,7 +33,7 @@

{{ form.privacy_level.errors }} - + {{ form.privacy_level }}
diff --git a/groups/templates/groups/index.html b/groups/templates/groups/index.html index 6a9c89fe..47b9a3e4 100644 --- a/groups/templates/groups/index.html +++ b/groups/templates/groups/index.html @@ -10,7 +10,7 @@

{% block title %}

- + Create Group
diff --git a/templates/base.html b/templates/base.html index 77d1cd9e..f367c51d 100644 --- a/templates/base.html +++ b/templates/base.html @@ -68,50 +68,52 @@ {% endblock %} -{% csrf_token %} -
- {% include 'includes/navbar.html' %} -
+ {% csrf_token %} +
+ {% include 'includes/navbar.html' %} +
-
- {% if messages %} -
- {% for message in messages %} -
{{ message }}
- {% endfor %} -
- {% endif %} +
+ {% if messages %} +
+ {% for message in messages %} +
{{ message }}
+ {% endfor %} +
+ {% endif %} -
- {% block content %}{% endblock %} -
-
+
+ {% block content %}{% endblock %} +
+
- + From da5916d652f09d5445dd209ea809352e5a6b47bf Mon Sep 17 00:00:00 2001 From: Ben Lawrence <65065992+Bentheminernz@users.noreply.github.com> Date: Tue, 24 Sep 2024 19:41:55 +1200 Subject: [PATCH 05/19] Footer sticks to bottom of page --- templates/base.html | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/templates/base.html b/templates/base.html index f367c51d..cf48384f 100644 --- a/templates/base.html +++ b/templates/base.html @@ -3,7 +3,7 @@ {% load django_htmx %} - + {% block title %}{% endblock %} | Splashcat @@ -67,13 +67,13 @@ {% block opengraph_head %} {% endblock %} - + {% csrf_token %}
{% include 'includes/navbar.html' %}
-
+
{% if messages %}
{% for message in messages %} @@ -83,13 +83,13 @@
{% endif %} -
+
{% block content %}{% endblock %}
-

{% include "users/includes/user-link.html" with user=group.owner show_splashtag=True %} {% if group.members.count > 0 %} -

Members

+

Members

{% for member in group.members.all %} {% include "users/includes/user-link.html" with user=member show_splashtag=True %} @@ -47,7 +47,7 @@

Members

{% endif %} -

Statistics

+

Statistics

Victories
@@ -63,7 +63,7 @@

Statistics

-

Recent Battles

+

Recent Battles

{% if group_recent_battles|length == 0 %}
No battles
From f19206cd867d5ffb4d85e8034469bb17c26ec7aa Mon Sep 17 00:00:00 2001 From: Ben Lawrence <65065992+Bentheminernz@users.noreply.github.com> Date: Tue, 24 Sep 2024 19:57:34 +1200 Subject: [PATCH 07/19] Last round of sizing tweaks --- templates/splashcat/home.html | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/templates/splashcat/home.html b/templates/splashcat/home.html index 647eb716..b2831b5d 100644 --- a/templates/splashcat/home.html +++ b/templates/splashcat/home.html @@ -93,9 +93,9 @@

Recent Battles

{% endfor %}
-

Data

+

Data

- Global Battle + Global Battle Data
{% endblock %} \ No newline at end of file From e05f33efc1634ceaa779b95dc43d787f8763e4a6 Mon Sep 17 00:00:00 2001 From: Ben Lawrence <65065992+Bentheminernz@users.noreply.github.com> Date: Tue, 24 Sep 2024 20:03:44 +1200 Subject: [PATCH 08/19] A few more style changes --- users/templates/users/settings.html | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/users/templates/users/settings.html b/users/templates/users/settings.html index 653bbd2a..74f2507b 100644 --- a/users/templates/users/settings.html +++ b/users/templates/users/settings.html @@ -151,7 +151,7 @@

GitHub Sponsors

{% endif %}
+ class="form-css flex flex-row gap-4 pt-1"> {% csrf_token %} Request Data Export Request a copy of your data from Splashcat.

- + {% csrf_token %} - +
From 99e58490a4508143fe839b6132e97b901937d73d Mon Sep 17 00:00:00 2001 From: Bentheminernz <65065992+Bentheminernz@users.noreply.github.com> Date: Tue, 24 Sep 2024 20:59:59 +1200 Subject: [PATCH 09/19] Update README.md --- README.md | 73 ++++++++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 72 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index d5ddb97a..b2d53cb1 100644 --- a/README.md +++ b/README.md @@ -1 +1,72 @@ -# splashcat +

+ +Splashcat +

+ +[Splashcat](http://splashcat.ink "Splashcat") is an award-winning service to track Splatoon 3 battles. Built upon Django, HTMX, _hyperscript, and Tailwind.CSS. + +##How to contribute +Thank you for taking the time to contribute to Splashcat! We appreciate your help. There are multiple ways you can help: +- [Getting Started](#getting-started) +- [Contributing to the codebase](#contributing) +- [Reporting bugs](#reporting-bugs) +- [Donating](https://github.com/sponsors/catgirlinspace) + +## Getting Started +Required Dependencies: [Python](https://www.python.org/downloads/ "Python"), [Poetry](http://python-poetry.org/docs "Poetry") & [NPM](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm "NPM") +1. Fork the repository. +2. Clone the repo: + ```bash + git clone https://github.com/your-username/your-repo-name.git + ``` +3. cd into the directory: +```bash + cd *file path* + ``` +4. Install dependencies: + ```bash + poetry install + npm install + npx update-browserslist-db@latest + npm run build + ``` +5. Run the website: + macOS/Linux: +```bash +poetry shell +./manage.py runserver +``` +Windows: +```bash +poetry shell +python manage.py runserver +``` + +## Contributing to the codebase +1. **Create a branch** for your feature or fix: + ```bash + git checkout -b myfeature + ``` +2. **Commit your changes**: + ```bash + git commit -m "Description of the change" + ``` +3. **Push** to the branch: + ```bash + git push origin myfeature + ``` +4. **Submit a pull request**. + +## Reporting Bugs +If you've found a bug in Splashcat please [report it! ](https://github.com/splashcat-ink/splashcat/issues/new "report it! ") +If it's a security vulnerability please contact splashcat@rosalina.saige.ink or use GitHub's tools for reporting security issues. Do **not** use a public GitHub issue. + +## Donating +Sponsoring me will support Splashcat and its server costs. Getting $5+ monthly tier also gives you some little additional features in Splashcat! For more details, see [here](https://splashcat.ink/sponsor/ "here") and to donate click [here](https://github.com/sponsors/catgirlinspace "here")! + +##Contact +Want to get in touch with us you can join the Discord server [here!](https://discord.gg/JPFwvbSWMS "here!") + +## License +Splashcat is licensed under the terms of the [AGPL-3.0 license ](https://github.com/splashcat-ink/splashcat/blob/main/LICENSE "AGPL-3.0 license ") + From caf70fb548a9f8c47e2323f19a6940b294925461 Mon Sep 17 00:00:00 2001 From: Bentheminernz <65065992+Bentheminernz@users.noreply.github.com> Date: Tue, 24 Sep 2024 21:02:26 +1200 Subject: [PATCH 10/19] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index b2d53cb1..937be2ce 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@

- + Splashcat

From 8bf7b148492bce1b11d432c3c279a2b20d387de2 Mon Sep 17 00:00:00 2001 From: Bentheminernz <65065992+Bentheminernz@users.noreply.github.com> Date: Tue, 24 Sep 2024 21:03:49 +1200 Subject: [PATCH 11/19] Update README.md --- README.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 937be2ce..74edab84 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,7 @@

-Splashcat +
+Splashcat

[Splashcat](http://splashcat.ink "Splashcat") is an award-winning service to track Splatoon 3 battles. Built upon Django, HTMX, _hyperscript, and Tailwind.CSS. @@ -20,7 +21,7 @@ Required Dependencies: [Python](https://www.python.org/downloads/ "Python"), [Po git clone https://github.com/your-username/your-repo-name.git ``` 3. cd into the directory: -```bash + ```bash cd *file path* ``` 4. Install dependencies: From c9bd11f8fe78abba91497a5b9a8dad991ab2c1b9 Mon Sep 17 00:00:00 2001 From: Bentheminernz <65065992+Bentheminernz@users.noreply.github.com> Date: Tue, 24 Sep 2024 21:05:45 +1200 Subject: [PATCH 12/19] Update README.md --- README.md | 29 +++++++++++++++-------------- 1 file changed, 15 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 74edab84..54be9f15 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ [Splashcat](http://splashcat.ink "Splashcat") is an award-winning service to track Splatoon 3 battles. Built upon Django, HTMX, _hyperscript, and Tailwind.CSS. -##How to contribute +## How to contribute Thank you for taking the time to contribute to Splashcat! We appreciate your help. There are multiple ways you can help: - [Getting Started](#getting-started) - [Contributing to the codebase](#contributing) @@ -15,10 +15,10 @@ Thank you for taking the time to contribute to Splashcat! We appreciate your hel ## Getting Started Required Dependencies: [Python](https://www.python.org/downloads/ "Python"), [Poetry](http://python-poetry.org/docs "Poetry") & [NPM](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm "NPM") -1. Fork the repository. +1. Fork the repository 2. Clone the repo: ```bash - git clone https://github.com/your-username/your-repo-name.git + git clone https://github.com/your-username/splashcat.git ``` 3. cd into the directory: ```bash @@ -32,16 +32,17 @@ Required Dependencies: [Python](https://www.python.org/downloads/ "Python"), [Po npm run build ``` 5. Run the website: - macOS/Linux: -```bash -poetry shell -./manage.py runserver -``` -Windows: -```bash -poetry shell -python manage.py runserver -``` +
+ macOS/Linux: + ```bash + poetry shell + ./manage.py runserver + ``` + Windows: + ```bash + poetry shell + python manage.py runserver + ``` ## Contributing to the codebase 1. **Create a branch** for your feature or fix: @@ -65,7 +66,7 @@ If it's a security vulnerability please contact splashcat@rosalina.saige.ink or ## Donating Sponsoring me will support Splashcat and its server costs. Getting $5+ monthly tier also gives you some little additional features in Splashcat! For more details, see [here](https://splashcat.ink/sponsor/ "here") and to donate click [here](https://github.com/sponsors/catgirlinspace "here")! -##Contact +## Contact Want to get in touch with us you can join the Discord server [here!](https://discord.gg/JPFwvbSWMS "here!") ## License From acf0d80fcbeccebab5fb806d18076e092e2da5b3 Mon Sep 17 00:00:00 2001 From: Bentheminernz <65065992+Bentheminernz@users.noreply.github.com> Date: Tue, 24 Sep 2024 21:10:23 +1200 Subject: [PATCH 13/19] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 54be9f15..3ef88e01 100644 --- a/README.md +++ b/README.md @@ -9,7 +9,7 @@ ## How to contribute Thank you for taking the time to contribute to Splashcat! We appreciate your help. There are multiple ways you can help: - [Getting Started](#getting-started) -- [Contributing to the codebase](#contributing) +- [Contributing to the codebase](#contributing-to-the-codebase) - [Reporting bugs](#reporting-bugs) - [Donating](https://github.com/sponsors/catgirlinspace) From 38e21054dc27d0012cf0efafb9bdbc3049bda57b Mon Sep 17 00:00:00 2001 From: Rosalina Date: Sun, 29 Sep 2024 23:21:47 -0400 Subject: [PATCH 14/19] format readme and reword some parts --- README.md | 54 +++++++++++++++++++++++++++++++++++------------------- 1 file changed, 35 insertions(+), 19 deletions(-) diff --git a/README.md b/README.md index 3ef88e01..15acadcb 100644 --- a/README.md +++ b/README.md @@ -4,26 +4,32 @@ Splashcat -[Splashcat](http://splashcat.ink "Splashcat") is an award-winning service to track Splatoon 3 battles. Built upon Django, HTMX, _hyperscript, and Tailwind.CSS. +[Splashcat](http://splashcat.ink "Splashcat") is an award-winning service to track Splatoon 3 battles. Built upon +Django, htmx, _hyperscript, and Tailwind CSS. ## How to contribute + Thank you for taking the time to contribute to Splashcat! We appreciate your help. There are multiple ways you can help: + - [Getting Started](#getting-started) - [Contributing to the codebase](#contributing-to-the-codebase) - [Reporting bugs](#reporting-bugs) - [Donating](https://github.com/sponsors/catgirlinspace) ## Getting Started -Required Dependencies: [Python](https://www.python.org/downloads/ "Python"), [Poetry](http://python-poetry.org/docs "Poetry") & [NPM](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm "NPM") + +Required +Dependencies: [Python](https://www.python.org/downloads/ "Python"), [Poetry](http://python-poetry.org/docs "Poetry") & [Node.js + NPM](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm "NPM") + 1. Fork the repository 2. Clone the repo: ```bash git clone https://github.com/your-username/splashcat.git ``` -3. cd into the directory: - ```bash - cd *file path* - ``` +3. cd into the directory: + ```bash + cd *file path* + ``` 4. Install dependencies: ```bash poetry install @@ -34,17 +40,18 @@ Required Dependencies: [Python](https://www.python.org/downloads/ "Python"), [Po 5. Run the website:
macOS/Linux: - ```bash - poetry shell - ./manage.py runserver - ``` + ```bash + poetry shell + ./manage.py runserver + ``` Windows: - ```bash - poetry shell - python manage.py runserver - ``` + ```bash + poetry shell + python manage.py runserver + ``` ## Contributing to the codebase + 1. **Create a branch** for your feature or fix: ```bash git checkout -b myfeature @@ -60,15 +67,24 @@ Required Dependencies: [Python](https://www.python.org/downloads/ "Python"), [Po 4. **Submit a pull request**. ## Reporting Bugs -If you've found a bug in Splashcat please [report it! ](https://github.com/splashcat-ink/splashcat/issues/new "report it! ") -If it's a security vulnerability please contact splashcat@rosalina.saige.ink or use GitHub's tools for reporting security issues. Do **not** use a public GitHub issue. + +If you've found a bug in Splashcat +please [report it! ](https://github.com/splashcat-ink/splashcat/issues/new "report it! ") +If it's a security vulnerability please contact splashcat@rosalina.saige.ink or use GitHub's tools for reporting +security issues. Do **not** use a public GitHub issue. ## Donating -Sponsoring me will support Splashcat and its server costs. Getting $5+ monthly tier also gives you some little additional features in Splashcat! For more details, see [here](https://splashcat.ink/sponsor/ "here") and to donate click [here](https://github.com/sponsors/catgirlinspace "here")! + +Sponsoring me will support Splashcat and its server costs. Getting the $5+ monthly tier also gives you some little +additional features in Splashcat! For more details, see https://splashcat.ink/sponsor/. ## Contact -Want to get in touch with us you can join the Discord server [here!](https://discord.gg/JPFwvbSWMS "here!") + +There's a Splashcat Discord server at https://discord.gg/JPFwvbSWMS and GitHub Discussions are available +at https://github.com/orgs/splashcat-ink/discussions. ## License -Splashcat is licensed under the terms of the [AGPL-3.0 license ](https://github.com/splashcat-ink/splashcat/blob/main/LICENSE "AGPL-3.0 license ") + +Splashcat is licensed under the terms of +the [AGPL-3.0 license ](https://github.com/splashcat-ink/splashcat/blob/main/LICENSE "AGPL-3.0 license ") From e9c897b14b50c301b982216999b9b6b74b0ef217 Mon Sep 17 00:00:00 2001 From: Rosalina Date: Sun, 29 Sep 2024 23:27:40 -0400 Subject: [PATCH 15/19] revert changes to settinsg.html + use a valid tailwind style --- users/templates/users/settings.html | 51 +++++++++++++++-------------- 1 file changed, 26 insertions(+), 25 deletions(-) diff --git a/users/templates/users/settings.html b/users/templates/users/settings.html index 74f2507b..516e34de 100644 --- a/users/templates/users/settings.html +++ b/users/templates/users/settings.html @@ -12,7 +12,8 @@

{% if user.stripe_customer_id %}
{% csrf_token %} - +
{% endif %}

@@ -44,34 +45,34 @@

- {% if "page-backgrounds" in user.entitlements %} - {{ form.page_background.errors }} - -

- Shown in the background of your profile and on battles. Note that backgrounds will be darkened - when shown. -

- {{ form.page_background }} - {% else %} -
- + {{ form.page_background.errors }} + +

+ Shown in the background of your profile and on battles. Note that backgrounds will be darkened + when shown. +

+ {{ form.page_background }} + {% if not "page-backgrounds" in user.entitlements %} +
+
+ Become a sponsor to customize your page background.
{% endif %} -
+
- {% if "favorite-color" in user.entitlements %} - {{ form.saved_favorite_color.errors }} - -

- Sub and special weapon icons will use this color on your profile and elsewhere on Splashcat. -

- {{ form.saved_favorite_color }} - {% else %} -
- + {{ form.saved_favorite_color.errors }} + +

+ Sub and special weapon icons will use this color on your profile and elsewhere on Splashcat. +

+ {{ form.saved_favorite_color }} + {% if not "favorite-color" in user.entitlements %} +
+
+ Become a sponsor to change your favorite color.
@@ -97,7 +98,7 @@

- Get this link from the + Get this link from the Nintendo Switch Online app . This link and your friend code are shown on your profile. @@ -179,7 +180,7 @@

API Keys

- + {% if user.api_keys.all %} From 705bc63d72701cf92fde596a9efc83425cdde012 Mon Sep 17 00:00:00 2001 From: Rosalina Date: Sun, 29 Sep 2024 23:29:13 -0400 Subject: [PATCH 16/19] fix invite text on group admin page (not really part of this pr exactly, but im committing it here anyways :3) --- groups/templates/groups/admin/index.html | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/groups/templates/groups/admin/index.html b/groups/templates/groups/admin/index.html index 07b62e73..67e59a13 100644 --- a/groups/templates/groups/admin/index.html +++ b/groups/templates/groups/admin/index.html @@ -95,7 +95,7 @@

Send Invites

{{ group_invite_form.as_div }} - + {% if group.pending_invites.count > 0 %} From 685398416aa90ab10f8b6d66e47ddaf5d7af6ab5 Mon Sep 17 00:00:00 2001 From: Rosalina Date: Sun, 29 Sep 2024 23:32:32 -0400 Subject: [PATCH 17/19] rearrange sponsor page slightly and adjust some padding the stripe climate link should be after the payment link buttons, and the padding around the "Payments are processed through Stripe" disclaimer felt very large. --- templates/splashcat/sponsor.html | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/templates/splashcat/sponsor.html b/templates/splashcat/sponsor.html index c32dd6ca..d2a44c41 100644 --- a/templates/splashcat/sponsor.html +++ b/templates/splashcat/sponsor.html @@ -25,7 +25,7 @@

<-- that's the cool badge! -
+
Payments are processed through Stripe.
@@ -35,7 +35,7 @@

Sponsor Features

  • Sponsor Badge Splashcat Sponsor + class="h-8 w-8 inline-block [image-rendering:pixelated]">

    Must configure GitHub sponsorship privacy as public to display.

    @@ -115,7 +115,7 @@

    Xponsor Features

    Receive insights on your battle data and create new battle groups with Splashcat Assistant. Example Thread + class="text-blue-500 underline text-base">Example Thread

    Sponsorship privacy does not affect this feature. @@ -124,12 +124,6 @@

    Xponsor Features

  • + All Sponsor and S+ponsor Features
    • - - Stripe Climate Badge - Splashcat contributes 1% to remove CO2 from the atmosphere. - -
    {% csrf_token %} @@ -146,6 +140,12 @@

    Xponsor Features

    + + Stripe Climate Badge + Splashcat contributes 1% to remove CO2 from the atmosphere. + + {% if current_sponsors|length > 0 %}

    Current Sponsors

    From cb835d30725cac54d2d0a92abce0fd21543c8e07 Mon Sep 17 00:00:00 2001 From: Rosalina Date: Sun, 29 Sep 2024 23:36:22 -0400 Subject: [PATCH 18/19] store user.api_keys.all in a template variable without this the sql query is repeated twice --- users/templates/users/settings.html | 52 +++++++++++++++-------------- 1 file changed, 27 insertions(+), 25 deletions(-) diff --git a/users/templates/users/settings.html b/users/templates/users/settings.html index 516e34de..fcb50de6 100644 --- a/users/templates/users/settings.html +++ b/users/templates/users/settings.html @@ -181,33 +181,35 @@

    API Keys

    - {% if user.api_keys.all %} -
    - - - - - - - - - - {% for api_key in user.api_keys.all %} + {% with api_keys=user.api_keys.all %} + {% if api_keys %} +
    KeyNoteCreatedDelete
    + - - - - + + + + - {% endfor %} - -
    {{ api_key.key }}{{ api_key.note }}{{ api_key.created }} -
    - {% csrf_token %} - -
    -     		KeyNoteCreatedDelete
    - {% endif %} + + + {% for api_key in api_keys %} + + {{ api_key.key }} + {{ api_key.note }} + {{ api_key.created }} + +
    + {% csrf_token %} + +
    + + + {% endfor %} + + + {% endif %} + {% endwith %}
    From a0f11c568debb656ce979910ef92f2bec6ffb359 Mon Sep 17 00:00:00 2001 From: Bentheminernz <65065992+Bentheminernz@users.noreply.github.com> Date: Mon, 30 Sep 2024 19:31:55 +1300 Subject: [PATCH 19/19] Removes useless if username check --- users/templates/users/includes/user-link.html | 90 +++++++++---------- 1 file changed, 43 insertions(+), 47 deletions(-) diff --git a/users/templates/users/includes/user-link.html b/users/templates/users/includes/user-link.html index 5337e951..7694d57c 100644 --- a/users/templates/users/includes/user-link.html +++ b/users/templates/users/includes/user-link.html @@ -1,52 +1,48 @@ {% load static %} -{% if user.username %} - - {% if user.profile_cover and user.profile_picture %} -
    - {{ user.display_name }}'s profile cover - {{ user.display_name }}'s profile picture -
    -
    - {{ user.display_name }} - {% if user.display_sponsor_badge %} - Splashcat Sponsor - {% endif %} -
    -
    @{{ user.username }}
    +     + {% if user.profile_cover and user.profile_picture %} +
    + {{ user.display_name }}'s profile cover + {{ user.display_name }}'s profile picture +
    +
    + {{ user.display_name }} + {% if user.display_sponsor_badge %} + Splashcat Sponsor + {% endif %}
    +
    @{{ user.username }}
    - {% else %} -
    - {% if user.profile_picture %} - {{ user.display_name }} - {% endif %} -
    -
    - {{ user.display_name }} - {% if user.display_sponsor_badge %} - Splashcat Sponsor - {% endif %} -
    -
    @{{ user.username }}
    +
    + {% else %} +
    + {% if user.profile_picture %} + {{ user.display_name }} + {% endif %} +
    +
    + {{ user.display_name }} + {% if user.display_sponsor_badge %} + Splashcat Sponsor + {% endif %}
    +
    @{{ user.username }}
    - {% endif %} - {% if show_splashtag == True %} - {% with user.get_splashtag as splashtag %} - {% if splashtag %} - {% include "includes/splashtag.html" with splashtag=splashtag %} - {% endif %} - {% endwith %} - {% endif %} -     -{% else %} -

    No username available

    -{% endif %} \ No newline at end of file +
    + {% endif %} + {% if show_splashtag == True %} + {% with user.get_splashtag as splashtag %} + {% if splashtag %} + {% include "includes/splashtag.html" with splashtag=splashtag %} + {% endif %} + {% endwith %} + {% endif %} +