Splashcat

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
Contributing to the codebase
Reporting bugs
Donating

Getting Started

Required Dependencies: Python, Poetry & Node.js + NPM

Fork the repository

Clone the repo:

git clone https://github.com/your-username/splashcat.git

cd into the directory:
```
cd *file path*
```

Install dependencies:

poetry install
npm install
npx update-browserslist-db@latest
npm run build

Run the website:
macOS/Linux:

poetry shell
./manage.py runserver

Windows:

poetry shell
python manage.py runserver

Contributing to the codebase

Create a branch for your feature or fix:
```
git checkout -b myfeature
```

Commit your changes:

git commit -m "Description of the change"

Push to the branch:
```
git push origin myfeature
```
Submit a pull request.

Reporting Bugs

If you've found a bug in Splashcat please 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

splashcat-ink / splashcat

readme