diff --git a/README.md b/README.md index d5ddb97a..15acadcb 100644 --- a/README.md +++ b/README.md @@ -1 +1,90 @@ -# 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-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") & [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* + ``` +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 the $5+ monthly tier also gives you some little +additional features in Splashcat! For more details, see https://splashcat.ink/sponsor/. + +## Contact + +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 ") + 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/admin/index.html b/groups/templates/groups/admin/index.html index 5c52beaf..67e59a13 100644 --- a/groups/templates/groups/admin/index.html +++ b/groups/templates/groups/admin/index.html @@ -33,7 +33,7 @@

{{ form.privacy_level.errors }} - + {{ form.privacy_level }}
@@ -95,7 +95,7 @@

Send Invites

{{ group_invite_form.as_div }} - + {% if group.pending_invites.count > 0 %} diff --git a/groups/templates/groups/index.html b/groups/templates/groups/index.html index 6a9c89fe..01740347 100644 --- a/groups/templates/groups/index.html +++ b/groups/templates/groups/index.html @@ -10,13 +10,13 @@

{% block title %}

- + Create Group
{% if member_groups|length > 0 %} -

Joined Groups

+

Joined Groups

{% for group in member_groups %} {% include "groups/includes/card.html" with group=group %} @@ -25,7 +25,7 @@

Joined Groups

{% endif %} {% if random_public_groups|length > 0 %} -

Discover

+

Discover

{% for group in random_public_groups %} {% include "groups/includes/card.html" with group=group %} diff --git a/groups/templates/groups/view.html b/groups/templates/groups/view.html index 16db33ed..b93c0d7f 100644 --- a/groups/templates/groups/view.html +++ b/groups/templates/groups/view.html @@ -9,10 +9,10 @@

{% if user.is_staff %} - Admin + Admin {% endif %} {% if group.owner == user %} - Manage Group + Manage Group {% endif %} {% if is_group_member and group.owner != user %} Owner {% 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
diff --git a/templates/base.html b/templates/base.html index f8456c26..cf48384f 100644 --- a/templates/base.html +++ b/templates/base.html @@ -3,7 +3,7 @@ {% load django_htmx %} - + {% block title %}{% endblock %} | Splashcat @@ -67,51 +67,54 @@ {% block opengraph_head %} {% 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 %} +
+
- + + 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 diff --git a/templates/splashcat/sponsor.html b/templates/splashcat/sponsor.html index c9294a63..d2a44c41 100644 --- a/templates/splashcat/sponsor.html +++ b/templates/splashcat/sponsor.html @@ -7,7 +7,7 @@ {% endblock %} {% block content %} -

+

Heya!

@@ -29,109 +29,116 @@

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 %} - -
+
+

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
    • +
+ +
+
+ {% 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
    • -
Stripe Climate Badge {{ user.display_name }}'s profile cover + alt="{{ user.display_name }}'s profile cover" + class="max-w-[350px] max-h-56 w-full object-cover rounded"> {{ user.display_name }}'s profile picture + alt="{{ user.display_name }}'s profile picture" + class="aspect-square w-1/5 object-cover rounded-xl shadow-2xl bottom-0 left-3 absolute">
{{ user.display_name }} {% if user.display_sponsor_badge %} Splashcat Sponsor + class="h-6 inline-block [image-rendering:pixelated]"> {% endif %}
@{{ user.username }}
@@ -23,15 +23,15 @@
{% if user.profile_picture %} {{ user.display_name }} + alt="{{ user.display_name }}" + class="h-12 w-12 object-cover rounded-lg"> {% endif %}
{{ user.display_name }} {% if user.display_sponsor_badge %} Splashcat Sponsor + class="h-6 inline-block [image-rendering:pixelated]"> {% endif %}
@{{ user.username }}
@@ -45,4 +45,4 @@ {% endif %} {% endwith %} {% endif %} - \ No newline at end of file + diff --git a/users/templates/users/settings.html b/users/templates/users/settings.html index df2d7c7e..fcb50de6 100644 --- a/users/templates/users/settings.html +++ b/users/templates/users/settings.html @@ -9,14 +9,11 @@

Settings

-
- {% csrf_token %} - -
{% if user.stripe_customer_id %}
{% csrf_token %} - +
{% endif %}
@@ -31,19 +28,19 @@

{{ form.display_name.errors }} - + {{ form.display_name }}
{{ form.profile_picture.errors }} - + {{ form.profile_picture }}
{{ form.profile_cover.errors }} - + {{ form.profile_cover }}
@@ -57,7 +54,7 @@

{{ form.page_background }} {% if not "page-backgrounds" in user.entitlements %}
-
+
Become a sponsor to customize your page background. @@ -74,7 +71,7 @@

{{ form.saved_favorite_color }} {% if not "favorite-color" in user.entitlements %}
-
+
Become a sponsor to change your favorite color. @@ -101,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. @@ -117,7 +114,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 }}
@@ -155,7 +152,7 @@

GitHub Sponsors

{% endif %}
+ class="form-css flex flex-row gap-4 pt-1"> {% csrf_token %} GitHub Sponsors

-

API Keys

+

API Keys

Create API keys to upload data to Splashcat.

@@ -184,31 +181,47 @@

API Keys

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

Request Data Export

+

+ Request a copy of your data from Splashcat. +

+ +
+ {% csrf_token %} + +